你如何填充 Xcode 4“Option+Click”弹出框？答案

【问题标题】：How do you populate the Xcode 4 "Option+Click" popover?你如何填充 Xcode 4“Option+Click”弹出框？
【发布时间】：2011-04-22 00:47:06
【问题描述】：

在 Xcode 4 中，如果你 option + 点击一个关键字，那么该关键字将出现在带有一堆描述性信息的弹出窗口中，如下所示：

但是，当我 option + 单击我自己的方法或变量时，我得到的只是指向声明对象的文件的链接：

这是怎么做到的？我可以在自己的代码中利用这一点吗？

（我注意到在一些框架标题中，有某种特殊的注释语法。这可能是相关的吗？）

【问题讨论】：

标签： xcode4

【解决方案1】：

您必须为您的 API 创建自己的“文档集”。在 Xcode 的文档中搜索“文档集指南”并深入了解。该指南的“文档集”部分特别指出 Quick Help 使用了它。

设置好文档后，此弹出窗口不仅可以找到描述，而且还可以在“实用工具”窗格的“快速帮助”以及“管理器”中的文档浏览器中使用。

【讨论】：

我已经对此进行了一些研究，您听起来是对的。请继续调查。
非常酷，这似乎远非简单，但看起来很棒！
太糟糕了，Apple 没有将其内部文档工具作为 Xcode 工具的一部分发布。再说一次，我听说它可能无法通过开发者社区的认可（阅读“可以使用大修”）。 :-)
@JoshuaNozzi 呵呵。我听到了。

【解决方案2】：

从 Xcode 5.0 开始，变量和方法的 Doxygen 和 HeaderDoc 格式会自动解析并在快速帮助弹出窗口中呈现。有关它的更多信息here，但这里有一些关键位：

/**
 * Add a data point to the data source.
 * (Removes the oldest data point if the data source contains kMaxDataPoints objects.)
 *
 * @param aDataPoint An instance of ABCDataPoint.
 * @return The oldest data point, if any.
 */
 - (ABCDataPoint *)addDataToDataSource:(ABCDataPoint *)aDataPoint;

在 Xcode 中呈现为：

至于属性，很简单：

/// Base64-encoded data.
@property (nonatomic, strong) NSData *data;

当点击选项时，会出现这个可爱的弹出框：

【讨论】：

当您在文件本身中时，这可以正常工作（如图所示）。但是，如果您正在处理使用该类的另一段代码，则选项单击似乎会丢失文档。我错过了什么吗？有没有办法让文档在整个过程中填充？