Xcode 4内置帮助您自己的文件

时间:2011-05-13 15:10:19

标签: objective-c xcode macos documentation xcode4

Xcode 4有一个非常好的内置帮助/文档,您可以访问,例如通过在代码中单击alt标识符,或打开右侧边栏中的帮助面板。但是,这仅适用于Apple提供的类和方法。有没有办法在自己的代码中编写某种文档注释(例如Java中的Javadoc注释),以使Xcode在这些文档面板中显示它们?

2 个答案:

答案 0 :(得分:2)

http://developer.apple.com/library/mac/#documentation/DeveloperTools/Conceptual/HeaderDoc/intro/intro.html

它由Apple维护,所以应该得到很好的支持。我从来没有真正使用它,可以稍后再试。

答案 1 :(得分:1)

好吧,看起来好像没有好的工具......有一些不同的工具,但它们不完美且难以配置。我无法让Doxygen或Appledoc工作,Avizzv92提到的工具在其他地方被称为“一堆便便”,所以我宁愿不尝试...... :)

我发现的信息:

How do you document your source code in Xcode?

http://wangling.me/2010/07/documentation-set-generation-tool-in-xcode-is-wanted/

http://developer.apple.com/tools/creatingdocsetswithdoxygen.html

http://www.gentlebytes.com/home/appledocapp/

http://lists.apple.com/archives/xcode-users/2011/Apr/msg00238.html