你如何填充Xcode 4“Option + Click”popover？

Question

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

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

这是怎么做到的？我可以利用这个来获取自己的代码吗？

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

Answer 1

您必须为API创建自己的“文档集”。搜索Xcode的“文档集指南”文档并深入研究。本指南的“文档集”部分明确指出快速帮助使用它。

设置了doc文档后，此弹出窗口不仅可以找到描述，还可以在Utility窗格中的QuickHelp以及Organizer中的文档浏览器中找到它。

Answer 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;

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