使用appledoc进行开发文档编写

appledoc是最年轻的一个,并且只为Objective-C服务(很专一),能生成和Apple一个风格的文档,功能齐全,使用方便,还可以直接编译成docset安装进xcode。。看样子除了语言支持太少,其他的表现都不错,关键是最贴合Xcode。 虽然没有统计数据,但我相信ObjC这个用的人应该是最多的。

appledoc 是在 stackoverflow 上被大家推荐的一个注释工具。有几个原因造成我比较喜欢它:

它默认生成的文档风格和苹果的官方文档是一致的,而 doxygen 需要另外配置。

appledoc 就是用 objective-c 生成的,必要的时候调试和改动也比较方便。

可以生成 docset,并且集成到 Xcode 中。这一点是很赞的,相当于在源码中按住 option 再单击就可以调出相应方法的帮助。

appledoc 源码在 github 上,而 doxygen 在 svn 上。我个人比较偏激地认为比较活跃的开源项目都应该在 github 上。

相对于 headerdoc,它没有特殊的注释要求,可以用 /** */ 的格式,也可以兼容 /*! */ 的格式的注释,并且生成的注释有汇总页面。

安装

安装appledoc出现错误

image.png

原因:xcodebuild找不到Xcode,要重定向一下Xcode的文档的位置。

解决办法:

使用命令

$ sudo xcode-select --switch /Applications/Xcode.app/Contents/Developer/

使用

cd到当前项目下执行

appledoc --output ./doc --project-name SMKJSmartDiagnose --project-company zhoujian --company-id zhoujian .

appledoc集成到我们自己的工程中,按照教程失败了(http://www.cocoachina.com/ios/20161125/18183.html)

当你cd 把工程拖入终端后,执行上面的命令后,出现:

image.png

cd到2级目录下即可解决

image.png

推荐阅读更多精彩内容