版權聲明

所有的部落格文章都可以在右邊[blog文章原始檔案]下載最原始的文字檔案,並依你高興使用 docutil 工具轉換成任何對應的格式方便離線閱覽,除了集結成書販賣歡迎任意取用,引用

doxygen in XCode

doxygen in XCode

程式的註解說明文件是非常重要的,小弟以為一個工程師隊自己的程式 有沒有愛,很多時候註解可以看的出來,因此開始研究iPhone的程式 後第二件事就尋找有沒有自動生產註解文件的方法。

Apple 這方面還是比微軟開明些,市面上已經具備好用的東西 Apple 似乎比較傾向直接使用,比如gcc和今天要介紹的 doxygen。

下載位置 http://www.stack.nl/~dimitri/doxygen/

Doxygen 的註解撰寫格式遵循 javadoc 所以有開發過 java 的朋友 因該十分熟悉註解的撰寫方式,沒寫過的也不用擔心其實十分簡單去官方 看一下說明和範例就好了。

下載後的執行畫面可能和我貼的不同,這沒關係反正重要的幾個設定每個 版本都差不多。

http://www.quicksnapper.com/files/5896/5435718954A39A93FC443B.png

Step

1. 先讓Doxygen跑一次,讓他建立設定檔並將設定檔丟到你的程式專案 目錄下

  1. 到 Xcode 的 Group & Files 欄位,在 Target 按右鍵叫出pop-up menu
  2. 選擇 [Add]->[New Build Phase]->[New Run Script Build Phase]
http://www.quicksnapper.com/files/5896/8877953654A39B05A42A23.png
  1. 在 script 輸入: /Applications/Doxygen.app/Contents/Resources/doxygen Doxyfile
http://www.quicksnapper.com/files/5896/18116308504A39B19E7C217_m.png

這樣每次Build就會自動呼叫Doxygen 讀取專案目錄下面的 Doxyfile 來產生說明檔了。

沒有留言:

Related Posts with Thumbnails