使用文档生成工具:appledoc

 

appledoc

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

  1. 它默认生成的文档风格和苹果的官方文档是一致的,而doxygen需要另外配置。
  2. appledoc就是用objective-c生成的,必要的时候调试和改动也比较方便。
  3. 可以生成docset,并且集成到xcode中。这一点是很赞的,相当于在源码中按住option再单击就可以调出相应方法的帮助。
  4. appledoc源码在github上,而doxygen在svn上。我个人比较偏激地认为比较活跃的开源项目都应该在github上。
  5. 相对于headerdoc,它没有特殊的注释要求,可以用/** */ 的格式,也可以兼容/*! */的格式的注释,并且生成的注释有汇总页面。

安装

那么简单介绍一下如何安装appledoc,安装非常简单,只需要2步:

 
git clone git://github.com/tomaz/appledoc.git  
cd appledoc  
sudo sh install-appledoc.sh

使用

使用appledoc时,只需要用如下命令即可:

 
appledoc -o ./doc --project-name ynote --project-company youdao .

appledoc会扫描当前路径下的所有文件,然后生成好文档放到doc目录下。你也可以用appledoc –help查看所有可用的参数。

基本上使用起来还是比较方便的,详细的信息可以查看官方的文档:http://gentlebytes.com/appledoc/

 

标签:

分类:iOS开发 | 发布:inzaghi | 评论:0 条 | 发表时间:2016-03-7 14:55
引用:点击这里获取该日志的TrackBack引用地址
上一篇:
下一篇:

发表评论

*

* 绝不会泄露


Design By Inzaghi | 京ICP备16047555号-1