DOXYGEN簡明實用教程
程式碼寫多了難免需要做文件,給自己還是給別人看都需要如此,這次XBOX360製作,前期沒怎麼寫註釋,回頭改Bug都要猜半天自己寫的程式碼是什麼意思。更別提別人寫的東西,100行程式碼也沒有一句註釋,幸好不是我維護,否則要瘋掉了。
花了一天功夫嘗試了一下Doxygen的使用,還好不難,但是有些磕磕絆絆,它自己的文件也說不清楚,網上搜出來的教程也只是給出樣子,遇到的問題還是靠自己嘗試了幾十次才搞定。
不管如何,常用的東西都可以弄出來了。貼在下面:
-----------------------------------------------------------------------------------
1.所有註釋都可以使用///開始(C++風格)。2.類體前必須加上///描述,否則會產生警告【Compound 類名 is not documented】 描述中最好不要帶有此類的類名,否則會產生兩個連結(但指向同一個檔案)影響美觀。3.public和protected會自動生成,但是private要在Expert的Build選項裡勾中EXTRACT_PRIVATE,static成員也是如此。4.函式註釋方式 /// Constructor【函式描述】 /// @param [in] pos The position of Camera in world coordinate 【引數描述1】 /// @param [in] lookat The point Camera looks at in world coordinate 【引數描述2】 BaseCamera( const D3DXVECTOR3& pos, const D3DXVECTOR3& lookat );5.變數註釋方式 D3DXVECTOR3 m_Position; /*!< Camera position point in world coordinate */ 或 D3DXVECTOR3 m_Position; ///< Camera position point in world coordinate兩種方式產生的結果不同。前者會單獨產生一塊Member Data Documentation註釋,後者會在Pubilc/Protected/Private Attributes變數描述後緊跟註釋。