iOS - appledoc 文档生成

为什么80%的码农都做不了架构师？>>>   

1.安装appledoc

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

or

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

2.使用appledoc

appledoc --no-create-docset --output ~/Desktop --project-name  projectname --project-company companyname --company-id company.id  ./

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

 

注意：appledoc 识别/**

* xxxx 

* xxxx

* xxxx

*/

这种类型的注释，否则不能生成文档

 

转载于:https://my.oschina.net/sccx/blog/744779