appledoc自动生成文档

appledoc是一个可以帮你生成Objective-C代码注释的辅助工具,appledoc所生成的注释API文档与苹果类库的API文档保持一致.

一 安装appledoc

安装的教程一抓一把

1:Mac安装Brew

我的mac 10.8.5的系统，不知道什么时候已经装好了brew，难道自带了吗？

安装命令如下：
curl -LsSf http://github.com/mxcl/homebrew/tarball/master | sudo tar xvz -C/usr/local --strip 1

当brew安装成功后，就可以随意安装自己想要的软件了，例如wget，命令如下：
sudo brew install appledoc

2.安装appledoc

appledoc github上地址如下

https://github.com/tomaz/appledoc

刚才装好了brew，通过命令安装appledoc

brew install appledoc 安装命令

安装后执行 :appledoc --help 如果有提示说明安装成功

二 自动生成代码

xcode上有个插件可以帮你生成代码注释

https://github.com/onevcat/VVDocumenter-Xcode

安装后，写代码的时候在方法名上面输入///可以自动生成如下注释

代码注释写好后通过appledoc自动生成 html文档

1. appledoc -p project_name     
2.          -c company_name
3.  --company-id com.test
4.   --no-create-docset
5.          --output /Desktop       
6.          /youprojectPath  

1 代表项目名称

2 代表公司名称

3 工程ID

4 不用集成到xcode文档中 （也就是创建html文件）

5 html文档输出路径

6 项目路径

这些命令是再终端中一行输完的，不要像上面一样换行

完成后到文档输出路径中打开index.html文件 

苹果风格文档 懒得写文档的程序员必备