生成技术文档主要有三个工具:
1.headerdoc,
优点:xcode 自带的文档生成工具、基于命令行的操作、使用方便。
缺点:但是只能生成以 /*! */ 的格式的注释。还有一个缺点是每个类文件对应一个注释文件,没有最后汇总导航的index文件。
2.doxygen,
优点:功能强大、三者中支持语言最多的、无headerdoc缺点、基于图形化的操作界面,
缺点:配置较多,可以生成html文档或pdf文档。
3.appledoc.
优点:基于命令行的操作、使用方便、无headerdoc缺点、默认生成的文档风格和苹果的官方文档是一致的,即docset,集成到xcode中就跟苹果的官方文档一模一样,在源码中按住option再单击就可以调出相应方法的帮助。当然也可以生成html文档。
时间: 2024-11-09 10:41:55