Xcode 文档与注释

最近在着手把公司项目的数据操作算法与界面控制分离开来,准备了一个数据操作的动态库用来写这部分代码,考虑到代码的使用对象,为本公司里,应用的编写人员,所以文档的需求就变得更为迫切。

大致考虑了一下,文档需要与方法编写同时产生。

应用

实际应用,就是比较简单的策略:

编写代码时,使用规范的注释。完成功能后,生成一遍注释,更新到网上。

选择

  • headerdoc2html

headerdoc2html为自带文档生成工具,命令即可操作,具体参数命令会提示。

  • doxygen

官方链接 doxygen

doxygen的非常不错,也有应用程序方便的生成文档,还有很多不同类的语言支持。

文档相关功能也挺不错的,目录结构,搜索,还有关系图表。

也有配置文件,方便下一次文档更新的生成。

目前暂定该方案。

Author

骆昱(Luo Yu), indie.luo@gmail.com

Monday, January 16, 2017