Xcode 4 为您自己的文件提供内置帮助
Xcode 4 有一个非常好的内置帮助/文档，您可以通过按住 Alt 键单击代码中的标识符或打开右侧边栏中的帮助面板来访问。但是，这只适用于 Apple 提供的类和方法。有没有办法在您自己的代码中编写某种文档注释（例如，Java 中的 Javadoc 注释）以使 Xcode 在这些文档面板中显示它们？
Xcode 4 has a very nice built-in help/documentation that you can access e.g. by alt-clicking an identifier in the code, or by opening the help panel in the right sidebar. However, this only works for classes and methods provided by Apple. Is there a way to write some kind of documentation comments (e.g. like the Javadoc comments in Java) in your own code to make Xcode display them in those documentation panels?
如果你对这篇内容有疑问，欢迎到本站社区发帖提问 参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱，如果其他用户或者作者回复了您的评论，将不能在第一时间通知您！
发布评论
评论（2）
http://developer.apple.com/ library/mac/#documentation/DeveloperTools/Conceptual/HeaderDoc/intro/intro.html
它由 Apple 维护，因此应该得到很好的支持。我从来没有实际使用过它，以后可能会尝试一下。
http://developer.apple.com/library/mac/#documentation/DeveloperTools/Conceptual/HeaderDoc/intro/intro.html
It's maintained by Apple so it should be well supported. I never actually used it, may try it later.
好吧，看起来确实没有好的工具......有一些不同的工具，但它们不完美且难以配置。我无法让 Doxygen 或 Appledoc 工作，并且 Avizzv92 提到的工具在其他地方被称为“一堆便便”，所以我不想尝试它......:)
我发现的信息：
< a href="https://stackoverflow.com/questions/174315/how-do-you-document-your-source-code-in-xcode">如何在 Xcode 中记录源代码？
<一个href="http://wangling.me/2010/07/documentation-set- Generation-tool-in-xcode-is-wanted/" rel="nofollow noreferrer">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
Ok, it looks like there's no good tool really... there are a few different ones, but they're imperfect and difficult to configure. I couldn't get Doxygen or Appledoc to work, and the tool mentioned by Avizzv92 is referred to as "a pile of poo" elsewhere, so I'd rather not try it... :)
Info that I've found:
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