DOXYGEN簡(jiǎn)明實(shí)用教程

1、DOXYGEN 簡(jiǎn)明實(shí)用教程DOXYGEN 簡(jiǎn)明實(shí)用教程1.所有注釋都可以使用III開始（C+風(fēng)格）。2類體前必須加上/描述，否則會(huì)產(chǎn)生警告【 Compound 類名 is not documented】描述中最好不要帶有此類的類名， 否則會(huì)產(chǎn)生兩個(gè)鏈接 （但 指向同一個(gè)文件 ）影響美觀。 3.public 和 protected 會(huì)自動(dòng)生成， 但是 private 要在 Expert 的 Build 選項(xiàng)里勾中 EXTRACT_PRIV ATE，static 成員也是如此。 4.函數(shù)注釋方式III Constructor 【函數(shù)描述】III param in posThe position

2、of Camera inworld coordinate 【參數(shù)描述 1 】III param in lookat The point Camera looks at in world coordinate 【參數(shù)描述 2】BaseCamera（ const D3DXVECTOR3& pos, const D3DXVECTOR3& lookat ）;5. 變量注釋方式D3DXVECTOR3 m_Position;I*!< Camera positionpoint in world coordinate *I 或D3DXVECTOR3 m_Position;III<

3、Camera positionpoint in world coordinate兩種方式產(chǎn)生的結(jié)果不同。前者會(huì)單獨(dú)產(chǎn)生一塊 Member Data Documentation 注釋，后者會(huì)在 Pubilc/Protected/Private Attributes 變量描述后緊跟注釋。 6.參數(shù)和 參數(shù)相同 7.產(chǎn)生描述順序和注釋順序相同，一般風(fēng)格為lll 函數(shù)描述lll param參數(shù)描述lll return返回值描述lll retval返回值 1 返回值1 描述lll retval返回值 2 返回值2 描述lll remarks注意事項(xiàng)Ill note注意事項(xiàng)，功能同remarks,顯示字樣

4、不同/ par 自定義圖塊，后面可跟示例代碼之類Ill code（必須使用 endcode結(jié)束）lll 示例代碼 （ 無需縮進(jìn) ）lll endcodelll see 其他參考項(xiàng)【產(chǎn)生指向參考的鏈接】 函數(shù)代碼聲明 8.特殊符號(hào)lll -產(chǎn)生一個(gè)黑色圓點(diǎn) 9.定義在類體里面的enumlll Camera typesenum CAMERA_TYPECAMERA_FIRST_VIEW,l*!< Camera that looks from the first view */CAMERA_MODEL_VIEW,/< Camera that looks from the third view;兩種風(fēng)格相同。以下開始的項(xiàng)都是全局非類內(nèi)定義，在 文件最開始 （ 我嘗試是在 include 之前 ） 必須加上【 / file 文 件名】，否則不會(huì)生成注釋 【沒有 File Member 頁】。10. 定義 在文件里面的宏#define CAMERA_TYPE_NUMBER/< Thenumber of camera types.或#define CAMERA_TYPE_NUMBER/*!< Thenumber of camera type