迴歸 從註釋開始 appledoc

很久沒有管理這個blog了，些許空虛。不知道今天的迴歸可否堅持。簡單介紹一個第三方註釋 -- appledoc

• appledoc http://gentlebytes.com/appledoc/

 

安裝過程：

1.    git clone git://github.com/tomaz/appledoc.git

2.    cd appledoc

3.　 sudo sh install-appledoc.sh

安裝完成。剩下的就是運行。

運行就是一句代碼，就是有些囉嗦的一句話：

appledoc --project-name name --project-company "company" --company-id bundleIdentifier --output 輸出路徑 要處理的文件夾路徑

實例：

appledoc --project-name appleDocTest --project-company "test" --company-id com.test.appledocTest --output /Users/xxxx/Desktop/  /Users/xxx/Documents/appledocTest/Utils 

--project-name  項目名稱

--project-company 公司名稱

--company-id 公司id

--output 輸出的路徑（只是輸出一個txt的說明文檔）

要生成註釋的類的路徑

 

還有一句簡單點的操做

appledoc --output ./doc --project-name name --project-company "company" --company-id bundleIdentifier

appledoc --output ./doc --project-name testAppledoc --project-company "test" --company-id cn.test.testAppledoc

這樣docset 默認集成在xcode中，在源碼中按住option再單擊就能夠調出相應方法的註釋。

 

如需獲取其餘參數使用  appledoc --help

OK ，差很少就是那麼簡單。你要生成html的樣子？ 好吧 知足你：

appledoc --no-create-docset --output ./doc --project-name name --project-company "company" --company-id bundleIdentifier

 

參考連接：https://github.com/tomaz/appledoc/blob/master/Readme.markdown

 補充一下：鑑於這個註釋須要一個特定的格式，推薦https://github.com/onevcat/VVDocumenter-Xcode， 直接git clone 或者Download zip,運行xcode工程後，重啓xcode，而後在方法名前 輸入/// 就能夠看到自動完成的註釋樣式了。很好用的說。