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;

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

Answer 2

好吧，对于课程来说，这个问题似乎还没有得到解答，所以我会发表我的建议。

在MyClass.h文件中的@interface MyClass : NSObject行之前，您可以像在示例中一样使用注释，但添加一些标记来显示文本。例如下面的代码：

/**
 * @class GenericCell
 * @author Average Joe
 * @date 25/11/13
 *
 * @version 1.0
 *
 * @discussion This class is used for the generic lists
 */

将产生以下输出： the output of the code above http://imageshack.com/a/img18/2194/kdi0.png

Answer 3

Appledoc是目前生成xcode文档的最佳选择。 Doxygen非常棒，但它不会生成适用于您正在谈论的弹出窗口的docset。 Appledoc并不完美，但我们转向它并对结果非常满意。

Answer 4

还可以在文档中添加一些代码段，如下所示

添加以下代码

 *  @code
 *  - (UIButton*) createButtonWithRect:(CGRect)rect
     {
        // Write your code here
     }
 * @endcode

有关记录自定义类方法的详细信息，请查看我的博客Function Documentation in Xcode。

Answer 5

要让Xcode显示您的类的文档，您必须使用Doxygen或HeaderDoc等工具为您的类创建文档集。创建文档集后，必须使用Xcode的文档首选项进行安装。 Apple有一篇关于使用Doxygen的文章，但它涵盖了Xcode 3，而不是4。

Using Doxygen to Create Xcode Documentation Sets