代碼寫(xiě)多了難免需要做文檔，給自己還是給別人看都需要如此，這次XBOX360制作，前期沒(méi)怎么寫(xiě)注釋?zhuān)仡^改Bug都要猜半天自己寫(xiě)的代碼是什么意思。更別提別人寫(xiě)的東西，100行代碼也沒(méi)有一句注釋?zhuān)液貌皇俏揖S護(hù)，否則要瘋掉了。

花了一天功夫嘗試了一下Doxygen的使用，還好不難，但是有些磕磕絆絆，它自己的文檔也說(shuō)不清楚，網(wǎng)上搜出來(lái)的教程也只是給出樣子，遇到的問(wèn)題還是靠自己嘗試了幾十次才搞定。

不管如何，常用的東西都可以弄出來(lái)了。貼在下面：

 -----------------------------------------------------------------------------------

1.所有注釋都可以使用///開(kāi)始(C++風(fēng)格)。

2.類(lèi)體前必須加上///描述，否則會(huì)產(chǎn)生警告【Compound 類(lèi)名 is not documented】
  描述中最好不要帶有此類(lèi)的類(lèi)名，否則會(huì)產(chǎn)生兩個(gè)鏈接(但指向同一個(gè)文件)影響美觀。

3.public和protected會(huì)自動(dòng)生成，但是private要在Expert的Build選項(xiàng)里勾中EXTRACT_PRIVATE，static成員也是如此。

4.函數(shù)注釋方式
    /// Constructor【函數(shù)描述】
    /// @param [in] pos       The position of Camera in world coordinate         【參數(shù)描述1】
    /// @param [in] lookat    The point Camera looks at in world coordinate    【參數(shù)描述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
兩種方式產(chǎn)生的結(jié)果不同。前者會(huì)單獨(dú)產(chǎn)生一塊Member Data Documentation注釋?zhuān)笳邥?huì)在Pubilc/Protected/Private Attributes變量描述后緊跟注釋。

6.@參數(shù)和\參數(shù)相同

7.產(chǎn)生描述順序和注釋順序相同，一般風(fēng)格為

    /// 函數(shù)描述
    /// @param     參數(shù)描述
    /// @return     返回值描述
    /// @retval     返回值1     返回值1描述
    /// @retval     返回值2     返回值2描述
    /// @remarks     注意事項(xiàng)
    /// @note    注意事項(xiàng)，功能同@remarks,顯示字樣不同
    /// @par    自定義圖塊，后面可跟示例代碼之類(lèi)
    /// @code(必須使用@endcode結(jié)束)
    /// 示例代碼(無(wú)需縮進(jìn))    
    /// @endcode
    /// @see     其他參考項(xiàng)【產(chǎn)生指向參考的鏈接】
    函數(shù)代碼聲明

8.特殊符號(hào)
    /// -        產(chǎn)生一個(gè)黑色圓點(diǎn)

9.定義在類(lèi)體里面的enum
    /// Camera types
    enum CAMERA_TYPE
    {
        CAMERA_FIRST_VIEW,/*!< Camera that looks from the first view */
        CAMERA_MODEL_VIEW,///< Camera that looks from the third view
    };
    兩種風(fēng)格相同。

以下開(kāi)始的項(xiàng)都是全局非類(lèi)內(nèi)定義，在文件最開(kāi)始(我嘗試是在include之前) 必須加上【/// \file 文件名】，否則不會(huì)生成注釋【沒(méi)有File Member頁(yè)】。

10. 定義在文件里面的宏
     #define CAMERA_TYPE_NUMBER     ///< The number of camera types.       或
     #define CAMERA_TYPE_NUMBER     /*!< The number of camera types. */
風(fēng)格說(shuō)明見(jiàn)5。

11. 非類(lèi)內(nèi)enum定義同10.        兩種風(fēng)格相同。見(jiàn)9。
12. 非類(lèi)內(nèi)typedef定義同10.     風(fēng)格說(shuō)明見(jiàn)5。