像API方法一样制作自己的功能描述[重复]答案

【问题标题】：Make own function description like in API methods [duplicate]像API方法一样制作自己的功能描述[重复]
【发布时间】：2011-10-23 04:07:00
【问题描述】：

是否有其他方法可以在 Objective-c 中记录您自己的函数/方法/变量？就像 C# 中的 XML 文档和 Java 中的 java doc。

【问题讨论】：

答案（或链接问题）中未提及：AppleDoc

标签： objective-c xcode

【解决方案1】：

我建议您使用Doxygen。这是我们在工作中内部使用的，而且效果很好。如果您最终需要它，您还可以将相同的系统用于其他语言，这也是一个额外的好处。

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

【讨论】：

【解决方案2】：

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

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

cmets 格式的文档here。

【讨论】：

【解决方案3】：

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

【讨论】：

看起来像我需要的！谢谢。

【解决方案4】：

大家好消息！ Xcode 5 现在内置了对 DOxygen 样式 cmets 的支持。因此，您可以像这样评论您的方法：

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

内联帮助将如下所示：

快速帮助如下所示：

侧边栏帮助将如下所示：

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

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

现在，您只需输入“doxy”就可以了！你有你的 doxygen 模板。

【讨论】：