doxygen從c++註釋生成設計說明

對於大多數寫程式碼的人來說，寫文件是一件既讓人感覺“沒有技術含量”、枯索無味而又冗長的事情。特別是設計說明這種馬後炮類的文件，幾乎到了讓人感覺到痛苦的地步。

而如今新的IDE、新的技術湧現，已經解決了部分文件的問題，也就是程式碼文件化。程式碼文件化不僅是一種時髦、漂亮，也不僅僅停留在程式設計規範紙上空文的層次，而儼然成為了猿猿們的一種關乎進度時間、能否正常下班的幾乎剛性的需求了。

c++可文件化註釋格式

分下類吧，1、變數註釋。2、函式方法註釋。3、結構體註釋。

簡要註釋的n種格式

1、

/** *@brief comment */

2、

/// comment

3、

//! comment

詳細註釋的n種格式

1、

/** * … text … */

2、

/*! … text … */

3、

/// /// … text … ///

4、

///////////////////////////////////////////////// /// … text … /////////////////////////////////////////////////

函式註釋

/**
 * @brief doSomeFuncT
 * @param val
 * @param bIf   HEAD HEHE
 * @return  HEAD HOW TO DEAL IT
 */
int doSomeFuncT(int val,bool bIf);

• 1
• 2
• 3
• 4
• 5
• 6
• 7

預設用javadoc格式的註釋肯定可以識別的。有個注意事項，如果標頭檔案與原始檔都寫了，會生成2份方法說明註釋，頭原始檔對應的各一份。

結構體成員註釋

/**
 * @brief The St_forExample struct
 */
struct St_forExample{
    int nId;            ///<id
    char chChannel;     ///<通道號
    bool bDoOrNot;      ///<是否操作
};

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8

///< comment

用上面的加到語句行尾即可完成註釋。

doxygen的使用

windows版本的有介面，選一下，配置一些選項即可。我想，對於嫻熟於軟體開發，周遊於各種IDE之間，聰明如你，肯定會摸清楚這個軟體的下載、使用方法的。：）。 版本：windows 1.8.12

如上圖所示，選下程式碼目錄，windows下的如果沒有切換作業系統成英文，老實把第一行編碼改成GBK吧。：）。 專家欄目中，把rtf選擇選上。 最後選run欄目，點下生成。就會在程式碼目錄下看到多出了幾個資料夾。rtf下有生成的文件，可轉成word格式的。 還有一個html的索引頁，可以索引到各個類、檔案進行瀏覽。

幾個效果圖如下：

生成的文件簡圖。

網頁索引介面。

最後，寫註釋的重要性是不言而喻的。那麼既然寫還是按規範寫好註釋吧，總會有那麼些時候讓自己感覺省時省力的。 ：）