文档框架,如ObjectiveD的JavaDoc

问题描述 投票:20回答:5

Objective C是否有类似于JavaDoc的文档框架,可以从源代码生成文档?

objective-c documentation-generation
5个回答
15
投票

Doxygen!您可以将它用于多种语言,包括Objective-c


10
投票

所有人都有好消息! :D最后等了很久之后,Apple为我们的项目引入了解析器注释。根据XCode 5中的new features

框架API参考文档中的项目文档和您自己的源代码中的结构化注释显示在快速帮助面板和代码完成弹出视图中。 Doxygen和HeaderDoc结构化注释是受支持的格式。

并从Clang 3.2发行说明:

Clang解析注释并可以检测注释中的语法和语义错误。默认情况下,这些警告是关闭的。传递-Wdocumentation标志以启用有关文档注释的警告。

如果您想查看此新功能的示例,我建议您查看以下文章:Documentation in Xcode 5


6
投票

Doxygen在Obj-C开发者中非常受欢迎。


3
投票

你可以看看HeaderDoc,它是类似于Java的苹果文档框架。


1
投票

Appledoc已经变得非常受欢迎。 。 。版本1基于Doxygen,而版本2则是从头开始编写的。

它并不具备Doxygen(图表,枚举,C ++类等)的所有功能,但它提供的是IDE集成格式的HTML格式精美的文档。

另外有趣的是以下内容:

  • CocoaPods工具包括它安装的库的Appledoc文档。非常方便。
© www.soinside.com 2019 - 2024. All rights reserved.