因为项目的完成已经接近于收官，所以，昨天经理开始让我整理技术文档，想到一点点慢慢写技术文档的麻烦，就觉得头疼，然后在网上搜索了一下，IOS主要使用的自动文档生成工具，就开是着手实验了。以下一一点点个人心得。
首先，关于appleDoc的安装，这这里我就出来问题，想想也是没谁了。
在网上搜索的时候，好多人都直接给的从github上拿来的东西，但是用的时候作为一个刚刚使用的小白，有太多不懂的地方了。
第一步，安装。这个比较简单，但就是等到时间会稍微长一点点。
打开你的终端。
打开终端
然后在上面输入一下代码：git clone git://github.com/tomaz/appledoc.git
下载appledoc
然后就是漫长的下载过程了。
正在下载中
下载完毕
然后就是进入appleDoc 目录下，cd appledoc
进入appledoc目录
在正常的安装上面，最重要的就是下一步了，因为其实并不是都能安装成功的。这个涉及到了电脑的权限问题。
当进入appledoc目录后，在终端输入 sudo sh install-appledoc.sh
这一步的时候是有可能会出错的，这个是默认安装到 /usr/local/bin 这个路径下面
当你的电脑并没有这个目录的时候，它其实是安装失败的，
当你电脑没有这个目录的时候，它其实也安装失败的，我看好多人们并没有说这一点，这个文件平时是隐藏的，这时可以在终端里面输入显示隐藏文件来查看是否安装成功了。我的做法是，进入该文件目录，然后自己创建了改路径，重新进行安装。
安装成功提示
自己创建的目录
附送显示和隐藏文件的命令
显示：defaults write com.apple.finder AppleShowAllFiles -bool true
隐藏：defaults write com.apple.finder AppleShowAllFiles -bool false
有些人说，下面两个命令是可以查看是否安装成功的，但是我实验过后，并不是这样，只要是文件装到电脑后，这两个命令都是可以用了的，所以推荐还是个人去看一下比较好。
appledoc --version
appledoc --help
各位，如果上面的安装命令不能用的话，官网也给出了一个命令，可以试一下这个命令。
sudo sh install-appledoc.sh -b /usr/bin -t ~/Library/Application\ Support/appledoc
官网的意思是说直接替换掉了默认的地址，我这个方法也测试过了，是可以使用的。
走到这里，就全部安装完毕了，下面就是使用它了，想想马上工作要结束了，是不是还有点小兴奋呢，哈哈，纯扯淡呢，如果你是第一次使用，并且自己的代码注释书写的并不规范，那么后面有的是罪受。
第二步，使用。
首先cd到你的项目类文件夹下，这个地方给大家提个醒，项目文件下面，但是一定要是你放类文件的上级文件夹下，而不是你项目的那个文件夹，因为很有可能会找不到，这个大家可以自己测试一下。
进入该目录下面
然后这时候，你可以根据自己想要的格式来生成输入自己的技术文档了。
生成html的命令代码：appledoc --no-create-docset --output ~/test --project-name "test" --company-id "com.aaaa" --project-company "aaaa"./
生成文档格式的话：appledoc --create-docset --output ~/test --project-name "test" --company-id "com.aaaa" --project-company "aaaa"./ （也就是去掉那个No就可以了）
这个是生成成功的表示
如果里面有一句：Oops, something went wrong... 这个表示生成失败，其中有那么警告什么的并不会影响生成，但是报错是可以的，比如我这个报错，现在还没有解决，去官网上查看了，也有人和我同样的报错，但是也同样还没解决。有遇到这种情况的大神也请帮忙看看。
然而官网没有解决方法
生成的文件
在 appledoc --help 里面可以看到更加详细的名字，以及有各种的报错提示。都是可以看看的，如果你是那种精益求精的人，那么最后的那些报错一定要去仔细的看一下，因为那个会影响文档的美观程度，还会影响有个别的类或者对象并不显示的问题。
这里分享一点个人的使用经验吧：
1.前往不要有重名的对象，分别在别的类里面也不可以。
2.自定义枚举的时候，一定要让在类文件下面，也就是说 @interface 这行代码下面
3.注释的格式一定也要注意，下面分享一个很有用的注释规范，大家可以去看看。
http://blog.ibireme.com/2013/08/26/appledoc-guide/
希望写的这篇文章会对大家有所帮助，那个BUG的问题如果解决了，我会更新自己的文章在里面告诉大家的。谢谢支持。
网友评论