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

Question

当我在键入Cocoa对象并在该对象上调用选择器时,我有时可以看到有关该方法的"文档"或"帮助"信息.例如,在我输入时[NSArray alloc],我看到两个帮助提示.一个用于NSArray,一个用于alloc.当我输入代码时,这两个都出现在弹出自动填充建议列表框中.

如何生成类似的方法/类修饰帮助提示,当我输入时会出现这些提示？我想在输入自定义类名和自定义方法时看到我的注释.我怎样才能做到这一点？

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

Answer 1

你必须创建一个"docset".appledoc等工具可以根据您的评论创建文档集.您可以设置一个在您的代码上运行appledoc的构建阶段.

问题是除了重启Xcode之外,没有办法让Xcode 4重新加载docset.因此,即使您在构建过程中自动运行appledoc,也必须重新启动Xcode以使其看到对docset的更改.