1. 程式人生 > >關於檢視自已寫的方法的“描述”(AppleDoc)

關於檢視自已寫的方法的“描述”(AppleDoc)

呵呵,才疏學淺,不知道怎麼描述了,以至於標題都寫的這麼有詩意,看下圖吧。

如上圖,一般來說,系統給的方法,當按著“Option”鍵+滑鼠點選的時候會彈出上圖,上面有描述啥的。而我們自已寫的方法,卻只有一句:

今天閒來無事兒,研究了一這個東東,發現原來我們自已寫的方法也可以實現最上面那張圖的效果的。原來這個東東叫作“文件”或者說是“幫助文件”,其實就是程式碼註釋和說明,按照一定的格式寫,然後通過一個叫作AppleDoc的神器轉換一下,就可以實現基本和系統文件差不多的效果,過程如下:
1.安裝AppleDoc

git clone git://github.com/tomaz/appledoc.git
cd appledoc
sudo sh install-appledoc.sh

會不會覺得上面的方法麻煩?我也是這麼認為的,所以我最先用了下面的方法:

brew install appledoc

省事倒是省事兒,很快就完事兒了,結果就是:一直有錯誤,不好使。最好還是乖乖的用了上面的方法,手動編譯的
2.使用AppleDoc

/usr/local/bin/appledoc \
--project-name umiwi \
--project-company rainbird \
--company-id com.umiwi.video.iphone \
--output ~/help \
.

就這麼一句話,別告訴我你不知道這是要在terminal裡輸的。
網上的教程基本上都是告訴你,第一步,第二步,然後就完事了,包括官方文件也是這麼幹的。
但是咱沒寫過文件啊,雖然有程式碼註釋的習慣,但是上面的指令運行了以後發現沒啥效果。腫麼個回事兒呢。
一方面:命令執行完,其實沒有實時的生效。我用的是xcode4.5.2,看好多資料說4.x以後,上面的指令執行以後,是實時生效的,實際上在我的4.5.2是不好使的,即使用了4.x以前用的那個AppleScript也不好使,所以這裡的忠告是:執行完上面的命令記得重啟一下xcode
另一方面:就是

文件的書寫格式的問題了嘛,試了半天,用下面的程式碼實現了下下面的效果:

/**
 檢查網路,有網路的話自動啟動下載任務
 @param  無 不需要引數
 @return 沒有返回值
 */
-(void)autoStartDownloadManager{
}


當然了,我上面只是舉例,像我這個函式,沒引數,沒返回值,沒必要寫@param和@return的。再有就是注意空格:/** 內容 */。如果寫一行就要注意“內容”的前後都要有空格。如果像我上面寫多行/**後面可以不用有空格,後面的東東前面都要有空格的喲。還有一個不爽的地方就是不管你@前面的內容是寫一行,還是寫幾行,顯示出來的時候都是連在一塊兒的,囧一個~
再有就是上面的那條命令嘛時候執行的問題,我們知道執行工程的時候,可以在工程編譯完執行一下指令碼,但是每次編譯程式都要執行一下這條指令碼是不是很浪費時間呢?如果覺得是的話,可以單建一個叫作“Aggregate”的Target,然後把指令碼寫上,需要生成文件的時候,執行一下。
再費話一句:我覺得這個生成文件的方式很雞肋呢。因為通過option+左鍵點選檢視定義有直接command+左鍵點選過去檢視快麼?後者雖然麻煩一點兒,但是不用想著再生成一遍文件啊。咋想都是個挺麻煩的事兒。