使用appledoc

安装

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

 git clone git://github.com/tomaz/appledoc.git 
 //打开下载的文件夹
 cd appledoc  
 //开始安装
 sudo sh install-appledoc.sh -b /usr/bin -t ~/Library/Application\ Support/appledoc  

这样就安装完毕了

然后开始生成文档
命令行输入

appledoc --no-create-docset --output ~/Desktop --project-name jielindoc --project-company ZQD --company-id com.ZQD ~/Desktop/JieLin6/JieLin6/Helpers/

--no-create-docset //不生成docset类型,生成html
--output ~/Desktop //文档生成的位置
--project-name jielindoc //工程的名字,其实这个可以随便取,至少取成工程的名字可以知道这个文档是哪个
--project-company ZQD
--company-id com.ZQD //公司的id
~/Desktop/JieLin6/JieLin6/Helpers/ //你要生成文档的注释类所在的文件目录,及工程目录

(个人感觉:刚开始觉得生成苹果那样的文档好牛逼啊,然后花了点时间自己弄了一下,也生成了文档,但是还是感觉没有直接看代码来的快,如果项目代码框架的写的好的话自己的代码就是一个很好的文档了)

推荐阅读更多精彩内容