? 因為項目的完成已經接近于收官，所以，昨天經理開始讓我整理技術文檔，想到一點點慢慢寫技術文檔的麻煩，就覺得頭疼，然后在網上搜索了一下，IOS主要使用的自動文檔生成工具，就開是著手實驗了。以下一一點點個人心得。
首先，關于appleDoc的安裝，這這里我就出來問題，想想也是沒誰了。
在網上搜索的時候，好多人都直接給的從github上拿來的東西，但是用的時候作為一個剛剛使用的小白，有太多不懂的地方了。
第一步，安裝。這個比較簡單，但就是等到時間會稍微長一點點。
打開你的終端。
然后在上面輸入一下代碼：git clone git://github.com/tomaz/appledoc.git
然后就是漫長的下載過程了。
然后就是進入appleDoc 目錄下，cd 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的問題如果解決了，我會更新自己的文章在里面告訴大家的。謝謝支持。
