xcode 自動添加注釋，生成文檔

一、自動生成注釋代碼

       添加一個快捷鍵，生成 注釋代碼

       ThisService 下載連接：http://wafflesoftware.net/thisservice/  

       Doxygen.rb 下載連接：http://www.brokenrul.es/blog/wp-content/uploads/2011/03/Doxygen.rb_.zip

 

1、打開ThisService，進行以下配置

 

Name:右鍵菜單中的名字

Script:將Doxygen.rb拖拽到這里

 

2、打開系統偏好設置，找到鍵盤，進行以下配置

這里我將快速文檔注釋的快捷鍵設置成了Command + option + /

 

3、使用

 

選中需要注釋的函數名，包括所有的參數，右鍵點擊快速文檔注釋，或者直接按快捷鍵即可。

 

 

 

二、生成文檔

    生成文檔有三種方式：

• docxygen http://www.stack.nl/~dimitri/doxygen/index.html
• headdoc http://developer.apple.com/opensource/tools/headerdoc.html
• appledoc http://gentlebytes.com/appledoc/

docxygen

docxygen 感覺是這3個工具中支持語言最多的，可以配置的地方也比較多。我大概看了一下文檔，覺得還是比較復雜，而且默認生成的風格與蘋果的風格不一致。就去看后面 2個工具的介紹了。另外，它雖然是開源軟件，但是沒有將源碼放到github上讓我感覺這個工具的開發活躍度是不是不夠。

headerdoc

headerdoc 是xcode 自帶的文檔生成工具。在安裝完xcode后，就可以用命令行：headdoc2html + 源文件名 來生成對應的文檔。我個人試用了一下，還是比較方便的，不過headerdoc的注釋生成規則比較特別，只生成以 /*! */ 的格式的注釋。還有一個缺點是每個類文件對應一個注釋文件，沒有匯總的文件，這點感覺有點不爽。

appledoc

appledoc是在stackoverflow上被大家推薦的一個注釋工具。有幾個原因造成我比較喜歡它：

1. 它默認生成的文檔風格和蘋果的官方文檔是一致的，而doxygen需要另外配置。
2. appledoc就是用objective-c生成的，必要的時候調試和改動也比較方便。
3. 可以生成docset，並且集成到xcode中。這一點是很贊的，相當於在源碼中按住option再單擊就可以調出相應方法的幫助。
4. appledoc源碼在github上，而doxygen在svn上。我個人比較偏激地認為比較活躍的開源項目都應該在github上。
5. 相對於headerdoc，它沒有特殊的注釋要求，可以用/** */ 的格式，也可以兼容/*! */的格式的注釋，並且生成的注釋有匯總頁面。

 

安裝

那么簡單介紹一下如何安裝appledoc，安裝非常簡單，只需要2步：

1 2 3

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

使用

使用appledoc時，只需要用如下命令即可：

1	appledoc -o ./doc --project-name ynote --project-company youdao .

appledoc會掃描當前路徑下的所有文件，然后生成好文檔放到doc目錄下。你也可以用appledoc –help查看所有可用的參數。

基本上使用起來還是比較方便的，詳細的信息可以查看官方的文檔：http://gentlebytes.com/appledoc/

Posted by 唐巧 Feb 1st, 2012  iOS, xcode

原創文章，版權聲明：自由轉載-非商用-非衍生-保持署名 | Creative Commons BY-NC-ND 3.0