? 因?yàn)轫?xiàng)目的完成已經(jīng)接近于收官，所以缕粹，昨天經(jīng)理開始讓我整理技術(shù)文檔稚茅，想到一點(diǎn)點(diǎn)慢慢寫技術(shù)文檔的麻煩，就覺得頭疼平斩，然后在網(wǎng)上搜索了一下亚享，IOS主要使用的自動(dòng)文檔生成工具，就開是著手實(shí)驗(yàn)了绘面。以下一一點(diǎn)點(diǎn)個(gè)人心得欺税。
首先，關(guān)于appleDoc的安裝揭璃，這這里我就出來(lái)問題晚凿，想想也是沒誰(shuí)了。
在網(wǎng)上搜索的時(shí)候瘦馍，好多人都直接給的從github上拿來(lái)的東西歼秽，但是用的時(shí)候作為一個(gè)剛剛使用的小白，有太多不懂的地方了情组。
第一步燥筷，安裝。這個(gè)比較簡(jiǎn)單院崇，但就是等到時(shí)間會(huì)稍微長(zhǎng)一點(diǎn)點(diǎn)肆氓。
打開你的終端。
然后在上面輸入一下代碼：git clone git://github.com/tomaz/appledoc.git
然后就是漫長(zhǎng)的下載過程了底瓣。
然后就是進(jìn)入appleDoc 目錄下谢揪，cd appledoc
在正常的安裝上面徙缴，最重要的就是下一步了觉鼻，因?yàn)槠鋵?shí)并不是都能安裝成功的北发。這個(gè)涉及到了電腦的權(quán)限問題劲蜻。
當(dāng)進(jìn)入appledoc目錄后秀又，在終端輸入 sudo sh install-appledoc.sh
這一步的時(shí)候是有可能會(huì)出錯(cuò)的渔隶，這個(gè)是默認(rèn)安裝到 /usr/local/bin 這個(gè)路徑下面
當(dāng)你電腦沒有這個(gè)目錄的時(shí)候官套，它其實(shí)也安裝失敗的酒奶，我看好多人們并沒有說這一點(diǎn)蚁孔，這個(gè)文件平時(shí)是隱藏的，這時(shí)可以在終端里面輸入顯示隱藏文件來(lái)查看是否安裝成功了惋嚎。我的做法是杠氢，進(jìn)入該文件目錄，然后自己創(chuàng)建了改路徑另伍，重新進(jìn)行安裝鼻百。
附送顯示和隱藏文件的命令
顯示：defaults write com.apple.finder AppleShowAllFiles -bool true
隱藏：defaults write com.apple.finder AppleShowAllFiles -bool false
有些人說，下面兩個(gè)命令是可以查看是否安裝成功的摆尝，但是我實(shí)驗(yàn)過后温艇，并不是這樣，只要是文件裝到電腦后堕汞，這兩個(gè)命令都是可以用了的勺爱，所以推薦還是個(gè)人去看一下比較好。
appledoc --version
appledoc --help
各位讯检，如果上面的安裝命令不能用的話琐鲁，官網(wǎng)也給出了一個(gè)命令，可以試一下這個(gè)命令人灼。
sudo sh install-appledoc.sh -b /usr/bin -t ~/Library/Application\ Support/appledoc
官網(wǎng)的意思是說直接替換掉了默認(rèn)的地址围段，我這個(gè)方法也測(cè)試過了，是可以使用的投放。
走到這里奈泪，就全部安裝完畢了，下面就是使用它了灸芳，想想馬上工作要結(jié)束了涝桅，是不是還有點(diǎn)小興奮呢，哈哈耗绿，純扯淡呢苹支，如果你是第一次使用砾隅，并且自己的代碼注釋書寫的并不規(guī)范误阻，那么后面有的是罪受。
第二步晴埂，使用究反。
首先cd到你的項(xiàng)目類文件夾下，這個(gè)地方給大家提個(gè)醒儒洛，項(xiàng)目文件下面精耐，但是一定要是你放類文件的上級(jí)文件夾下，而不是你項(xiàng)目的那個(gè)文件夾琅锻，因?yàn)楹苡锌赡軙?huì)找不到卦停，這個(gè)大家可以自己測(cè)試一下向胡。
然后這時(shí)候，你可以根據(jù)自己想要的格式來(lái)生成輸入自己的技術(shù)文檔了惊完。
生成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"./ （也就是去掉那個(gè)No就可以了）
這個(gè)是生成成功的表示
如果里面有一句：Oops, something went wrong... 這個(gè)表示生成失敗僵芹，其中有那么警告什么的并不會(huì)影響生成，但是報(bào)錯(cuò)是可以的小槐，比如我這個(gè)報(bào)錯(cuò)拇派，現(xiàn)在還沒有解決，去官網(wǎng)上查看了凿跳，也有人和我同樣的報(bào)錯(cuò)件豌，但是也同樣還沒解決。有遇到這種情況的大神也請(qǐng)幫忙看看控嗜。
在 appledoc --help 里面可以看到更加詳細(xì)的名字茧彤，以及有各種的報(bào)錯(cuò)提示。都是可以看看的疆栏，如果你是那種精益求精的人棘街，那么最后的那些報(bào)錯(cuò)一定要去仔細(xì)的看一下，因?yàn)槟莻€(gè)會(huì)影響文檔的美觀程度承边，還會(huì)影響有個(gè)別的類或者對(duì)象并不顯示的問題遭殉。
這里分享一點(diǎn)個(gè)人的使用經(jīng)驗(yàn)吧：
1.前往不要有重名的對(duì)象，分別在別的類里面也不可以博助。
2.自定義枚舉的時(shí)候险污，一定要讓在類文件下面，也就是說 @interface 這行代碼下面
3.注釋的格式一定也要注意富岳，下面分享一個(gè)很有用的注釋規(guī)范蛔糯，大家可以去看看。
http://blog.ibireme.com/2013/08/26/appledoc-guide/
希望寫的這篇文章會(huì)對(duì)大家有所幫助窖式，那個(gè)BUG的問題如果解決了蚁飒，我會(huì)更新自己的文章在里面告訴大家的。謝謝支持萝喘。
