像API方法一样制作自己的功能描述

Question

是否有一些替代方法可以在objective-c中记录您自己的函数/方法/变量？ 与C＃中的XML文档和Java中的Java doc一样。

Answer 1

我建议你使用Doxygen。这是我们在工作中内部使用的，它运作得非常好。如果你最终需要这个系统，那么你可以将同一系统用于其他语言也是一个额外的好处。

有一个很好的指南可以自动生成您的构建Doxygen文档：http://www.guidebee.biz/forum/viewthread.php?tid=168

Answer 2

自其他答案发布以来，已有一些发展。

AppleDoc已经发展并变得相当不错。它以Apple自己的页面风格创建文档页面，如果我正确地解释您的问题，这就是您所追求的。

评论格式here的文档。

Answer 3

我有deja vu ;-)无论如何，看起来Doxygen可以handle Objective-C as well;我没有亲自尝试过。

Answer 4

大家好消息！ Xcode 5现在内置了对DOxygen风格注释的支持。所以，你可以这样评论你的方法：

/*!
 * Provides an NSManagedObjectContext singleton appropriate for use on the main 
 * thread. If the context doesn't already exist it is created and bound to the 
 * persistent store coordinator for the application, otherwise the existing 
 * singleton contextis returned.
 * \param someParameter You can even add parameters
 * \returns The a shared NSManagedObjectContext for the application.
 */
+ (NSManagedObjectContext *)sharedContext;

内联帮助将如下所示：

快速帮助将如下所示：

侧栏帮助将如下所示：

这是一个方便的代码段，您可以添加Xcode Code Snippet库以简化方法文档：

/**
 <#description#>
 @param <#parameter#>
 @returns <#retval#>
 @exception <#throws#>
 */

现在，你可以输入“doxy”和poof！你有你的doxygen模板。