如何用文档装饰 Objective C 方法？答案

【问题标题】：How to decorate Objective C methods with documentation?如何用文档装饰 Objective C 方法？
【发布时间】：2012-09-14 02:40:08
【问题描述】：

当我键入一个 Cocoa 对象并在该对象上调用一个选择器时，我有时会看到有关该方法的“文档”或“帮助”信息。例如，当我输入[NSArray alloc] 时，我会看到两个帮助提示。一种用于NSArray，另一种用于alloc。当我键入代码时，这两个都会出现在弹出的自动完成建议列表框中。

如何生成类似的方法/类修饰帮助提示，这些提示会在我键入时出现？我想在输入自定义类名和自定义方法时看到我的 cmets。我该怎么做？

例如，C# 通过 XML 文档提供此功能，该文档可以放在任何方法、类或接口/协议声明之前。

【问题讨论】：

【解决方案1】：

您必须创建一个“文档集”。有像 appledoc 这样的工具可以从你的 cmets 创建文档集。您可以设置一个在您的代码上运行 appledoc 的构建阶段。

问题是没有办法让 Xcode 4 重新加载文档集，除非重新启动 Xcode。因此，即使您在构建过程中自动运行 appledoc，您也必须重新启动 Xcode 才能看到对您的 docset 所做的更改。

【讨论】：