appledoc使用说明
appledoc介绍
为了使代码便于阅读，或者所写的代码需要提供给别人使用，这时就需要文档了。而就我们程序员来说，最好的方式莫过于将文档和源码放在一起，在写代码时
通过一定的规范编写注释，然后通过工具可以将专门的注释部分抽取出来形成文档，类似的，JAVA语言就自带了javadoc命令。objective-c也中也有相应的工
具，经过比较，最终选择了appledoc来做注释工具。appledoc的优点有不少，比如注释风格自由，生成的文档风格与苹果官方文档是一致的，而且可以生成
docset，并且集成到xcode中去，也就是说，可以在源码中按住option键单击来调出相应方法的帮助。appledoc的详细资料，可以参考官方文档。点击这里
appledoc是在stackoverflow上被大家推荐的一个注释工具。有几个原因造成我比较喜欢它：
1、它默认生成的文档风格和苹果的官方文档是一致的，而doxygen需要另外配置。
2、appledoc就是用objective-c生成的，必要的时候调试和改动也比较方便。
3、可以生成docset，并且集成到xcode中。这一点是很赞的，相当于在源码中按住option再单击就可以调出相应方法的帮助。
4、appledoc源码在github上，而doxygen在svn上。我个人比较偏激地认为比较活跃的开源项目都应该在github上。
5、相对于headerdoc，它没有特殊的注释要求，可以用/** */ 的格式，也可以兼容/*! */的格式的注释，并且生成的注释有汇总页面。
安装
1、正常安装
2、Homebrew
先安装brew
安装命令如下：（http://blog.csdn.net/chenyi8888/article/details/7345113）
curl -LsSf http://github.com/mxcl/homebrew/tarball/master | sudo tar xvz -C/usr/local --strip 1
3、更新
安装完成后，验证一下OK了没:
使用
1、注释格式
我所用的注释格式。注：appledoc的注释内容中，支持基本markdown语法
类和类的成员变量说明：
/**
这里写内容
*/
函数注释：
/**
这里写主要说明（下面空一行之后可以写详细说明）
这里写详细说明
@param 参数1 参数1说明
@param 参数2 参数2说明
@return 返回内容说明
*/2、生成文档命令
进入到工程根目录，执行下面命令：
appledoc --project-name XXX --project-company "XXX" --company-id XXX --output /tmp/doc./Core
appledoc 会扫描当前路径下的所有文件，编译出的Docset默认会放在/Users/ibireme/Library/Developer/Shared/Documentation/DocSets
路径下。你也可以用 appledoc —help 查看所有可用的参数。其中，XXX 的内容根据具体情况填写，--output 后面接的是文档输出路径，最后一个路
径，是需要生成文档的源代码所在路径。默认情况，在生成docset文档后，appledoc会把生成的html以及中间文件删除，然后将生 成的docset文档放置到
xcode搜索的文档路径下。若要保存文档生成过程的中间数据比如生成的html文件，只需在上面的命令中增加以下参数即可。
--keep-intermediate-files总结
1、如何生成文档，最主要的是配置一个output的路径和input的路径；output路径可以任意指定；input路径是你需要生成appledoc的文件们所在的文件夹路径.
输入命令如上；其中/tmp/doc为output的设置路径,/Core是input路径；在实际操作时可以将路径所在的文件夹拖到终端里，文件夹的路径就会被自动输入到终
端里。生成文档后，在output路径下是一个包含有实际文件路径的txt，通过它你就可以找到所生成的appledoc的全部内容。
2、Docset格式，实际上是一个bundle,里面包含了一些xml和html。显示包内容后就可以查看和修改了。如果需要放到网站上，那单独将html部分取出来就
行。Docset安装后，在Xcode中就可以实时查看某个方法的说明了，体验和官方文档保持一致。（有一点，category中的注释不会出现在xcode的快速帮助中，
不知道新版xcode是否会有改进..）除了Xcode外，Dash支持得也很棒。强烈推荐～
附带
1、关于Xcode项目中的信息查看
- organization name ：会在每个.h和.m文件里面显示你的公司名
- company identifier ：APP的企业标识
- bundle identifier ： = company identifier + Product Name; 开发证书标识，要和开发证书名字一致
2、 关于xcode6中帮助文档（Documentation and API Reference）的位置以及自行安装帮助文档的方法：
安装步骤如下：
- 下载最新的帮助文档文件，格式为dmg
- 加载下载好的文件，将其中的docset文件安装到硬盘的任意位置，因为等下还需要移动
-
自Xcode进入6以后，文件的存放结构同以往已经发生不同，现在存放帮助文档的正确位置是
~/Library/Developer/Shared/Documentation/DocSets，将下载docse文件拷贝到此处即可，如果有别的docset文件，那么很可能是以前版本的帮助文档，删除即可 - 重启xcode，应该可以使用了
后记
在解决问题的过程中还发现有一个查看帮助文档的神器：dash，用了一会就感觉非常好用，我想很多人都已经知道
了。软件本身是免费的，但就是有时页面会故意加入延迟，督促你买正版（原文用的动词是:nag😄）。很想买正版，但只
是太贵了（128¥），等打折吧～以下是dash的使用界面，按照上面的方法，dash能够默认自动使用到xocde的帮助文档
