iOS ~ 自动生成技术文档
生成注释：
生成文档之前、我们需要给代码中的方法或者变量写上注释，然后利用工具根据这些规范的注释自动生成文档。所以，注释一定要规范统一。这里推荐使用Xcode的开源插件VVDocumenter，规范注释生成器，非常方便。
多行注释直接输入三个斜线"///" 会自动格式化、单行注释需要输入三个斜线+ 空格 "/// 注释" 。输入两个"//"Xcode 也是可以识别的，切记：但是在下面生成文档的时候不能被识别为文档注释。
/**
*<#Description#>
*/
-(void)viewDidLoad{
[super viewDidLoad];
//Doany additional setup after loading the view,typicallyfroma nib.
}
配合使用的工具
开源框架： Appledoc
引言：appledoc是一个可以帮你生成Objective-C代码注释的辅助工具，appledoc所生成的注释API文档与苹果类库的API文档保持一致，这样可以让Xcode也能够识别出我们自己的API文档
参考：
1:Mac安装Brew
http://blog.csdn.net/chenyi8888/article/details/734511
2:使用Objective-C的文档生成工具:appledoc
http://blog.devtang.com/blog/2012/02/01/use-appledoc-to-generate-xcode-doc/
3.安装：appledoc的Github托管地址如下：
https://github.com/tomaz/appledoc
基于命令行的操作、使用方便，默认生成的文档风格和苹果的官方文档是一致的，即docset集成到xcode中就跟苹果的官方文档一模一样，在源码中按住option再单击就可以调出相应方法的帮助。当然也可以生成html文档
headdoc: xcode自带的文档生成工具、基于命令行的操作、使用方便。但是只能生成以/*! */ 的格式的注释
doxygen ： 功能强大、三者中支持语言最多的、无headerdoc缺点、基于图形化的操作界面，但是配置较多，可以生成html文档或pdf文档。这2种工具这里不做阐述，网上很多使用说明，一般对于OC来说，目前比较好用的是appledoc和doxygen
工具的使用
appledoc:
从github下载源码，在终端里面cd 源码文件夹，然后执行shell脚本安装
git clone git://github.com/tomaz/appledoc.git
cd appledoc
sudo sh install-appledoc.sh
注意：安装过程中如果出错，检查下Xcode所在的路径中是否存在空格，去掉再试成功后显示：
SetModeu+w,go-w,a+rX/tmp/appledoc.dst/usr/local/bin/appledoc
cd/Users/renrenyichun/appledoc
/bin/chmod-RH u+w,go-w,a+rX/tmp/appledoc.dst/usr/local/bin/appledoc
Touchbuild/Release/appledoc.dSYM
cd/Users/renrenyichun/appledoc
/usr/bin/touch-c/Users/renrenyichun/appledoc/build/Release/appledoc.dSYM
**INSTALL SUCCEEDED**
Installingbinary to/usr/local/bin/
安装成功后在终端上输入 cd 项目文件夹 （想要生成文档的项目文件夹）
输入以下指令：
appledoc--output../doc--project-name weibo--project-company"wxhl"--company-id"com.wxhl.weibo".
上面代码的含义：
--output ../doc 设置文档输出目录为上级目录下面的doc
--project-name weibo 设置项目名为“weibo”
--project-company "wxhl" 设置公司名为“wxhl”
--company-id "com.wxhl.weibo" 设置公司id为“com.wxhl.weibo”
. 当前目录
注释指定路径下的文件renyichun:YCLoading 路径$ appledoc --output ../doc --project-name YCLoading --project-company "公司名" --company-id "com.组织.YCLoading" ./YCLoading
这样，我们项目中的第三方就不用在生成注释了。也没必要生成。
当该命令完成后，可以看到在上级目录的doc文件夹里面有一个docset-installed.txt的文件，这里描述了docset文档所在的真正路径，一般都是在~/Library/Developer/Shared/Documentation/DocSets/里面，或者查看Xcode说明API文档中可以看到，会发现新增了帮助文档
生成HTML
对于最新版本的appledoc来说，它默认时是生成docset文档并集成到xcode，当需要html文档时，可以加上"--no-create-docset"
appledoc--no-create-docset--output../doc--project-name weibo--project-company"wxhl"--company-id"com.wxhl.weibo".
当命令完成后，可以看到在上级目录的doc文件夹里面就不是docset-installed.txt文件了，而是全部的html文档，直接开打index就行。。。。
网友评论