Xcode 中 Objective-C 的类 JavaDoc 文档?

声明:本页面是StackOverFlow热门问题的中英对照翻译,遵循CC BY-SA 4.0协议,如果您需要使用它,必须同样遵循CC BY-SA许可,注明原文地址和作者信息,同时你必须将它归于原作者(不是我):StackOverFlow 原文地址: http://stackoverflow.com/questions/6225816/
Warning: these are provided under cc-by-sa 4.0 license. You are free to use/share it, But you must attribute it to the original authors (not me): StackOverFlow

提示:将鼠标放在中文语句上可以显示对应的英文。显示中英文
时间:2020-09-14 21:11:47  来源:igfitidea点击:

JavaDoc-like documentation for Objective-C in Xcode?

objective-cxcodedocumentationxcode4comments

提问by fzwo

Possible Duplicate:
How to do the documentation in objective C?

可能的重复:
如何在目标 C 中做文档?

Is it possible to write class/method documentation in Objective-C in a way that Xcode 4 displays them in the quick help, and/or generates a doc document from it in the style of Apple's own documentation?

是否有可能以 Xcode 4 在快速帮助中显示它们的方式在 Objective-C 中编写类/方法文档,和/或以 Apple 自己的文档样式从中生成文档文档?

回答by drekka

Displaying it live - not that I know of.

现场展示 - 我不知道。

But as for generating Apple like documentation, the best I have found is appledocwhich I've been using for a year now. If accepts a wide range of commenting styles including Javadoc styles and can generate very Apple like documentation which it can also install directly into your Xcode help system.

但至于生成类似 Apple 的文档,我发现的最好的是appledoc,我已经使用了一年了。如果接受广泛的注释样式,包括 Javadoc 样式,并且可以生成非常像 Apple 的文档,它也可以直接安装到您的 Xcode 帮助系统中。

回答by JeremyP

I don't know if it still works for Xcode 4 but for Xcode 3 you could generate API doc sets using doxygen.

我不知道它是否仍然适用于 Xcode 4,但对于 Xcode 3,您可以使用doxygen生成 API 文档集。

Apple has a set by step guide: Using doxygen to Create Xcode Documentation Setson how to do it.

Apple 有一套分步指南:Using doxygen to Create Xcode Documentation Sets关于如何做到这一点。

回答by Abizern

There is also the appledoctool available from GitHub. Makes nice docsets.

GitHub 上还提供了appledoc工具。制作不错的文档集。