Xcode:显示我的自定义类的文档

Question

如何强制 Xcode 显示我自己的自定义类、方法等文档？我习惯了 Java 和 Eclipse，它显示了我的类的文档，如下所示:

如何在 Xcode 中实现相同的效果？ Xcode 是否可以识别并显示特殊注释？

Answer 1

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

单击选项时，会出现这个可爱的弹出窗口: