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

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

我怎样才能在Xcode中实现相同？ Xcode可以识别和显示的特殊评论？

Answer 1

从Xcode 5.0起，variables和方法的Doxygen和HeaderDoc格式将自动分析并呈现在Quick Helppopup窗口中。 关于它的更多信息在这里 ，但是这里有一些关键的部分：

/** * 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; 

当点击选项，这个可爱的popover出现：

Answer 2

那么，这个问题似乎还没有回答，所以我会发表我的build议。

就在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 */ 

会产生如下输出： 上面代码的输出http://imageshack.com/a/img18/2194/kdi0.png

Answer 3

目前，Appledoc是生成xcode文档的最佳select。 Doxygen是伟大的，但它不会产生你所谈到的popup窗口很好的docsets。 Appledoc并不完美，但是我们转向了它，并对结果感到非常满意。

Answer 4

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

通过添加下面的代码

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

有关logging自定义类的方法的更多详细信息，请参阅我的博客Xcode中的函数文档 。

Answer 5

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

使用Doxygen创buildXcode文档集