文档框架,如ObjectiveD的JavaDoc

时间:2009-12-16 00:16:29

标签: objective-c documentation-generation

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

5 个答案:

答案 0 :(得分:15)

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

答案 1 :(得分:10)

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

  

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

Clang 3.2发行说明:

  

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

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

答案 2 :(得分:6)

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

答案 3 :(得分:3)

您可以查看HeaderDoc类似于Java的Apple文档框架。

答案 4 :(得分:1)

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

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

还有一点值得注意的是:

  • CocoaPods工具包含其安装的库的Appledoc文档。非常方便。