C++ doxygen講解

1、武漢中心項目部培訓(xùn)武漢中心項目部培訓(xùn) 文檔生成工具 Doxygen注釋風(fēng)格注釋風(fēng)格 Doxygen指令目的為了生成更豐富與可讀性更強(qiáng)的文檔。所 以總結(jié)5類常用的注釋風(fēng)格說明。 變量、宏定義、類型定義。 枚舉類型定義、結(jié)構(gòu)體類型定義類似。 函數(shù)定義。 模塊定義（單獨顯示一頁 ）。 分組定義（在一頁內(nèi)分組顯示）。 變量、宏定義、類型定義簡要說明變量、宏定義、類型定義簡要說明 變量、宏定義、類型定義注釋風(fēng)格類似。 格式： /* 簡要說明文字 */ 變量（宏定義或類型定義） 如： /* 簡要說明文字 */ #define FLOAT float /* brief 簡要說明文字（在前面加 brief 是

2、標(biāo)準(zhǔn)格式） */ #define MIN_UINT 0 /* * 分行的簡要說明 n * 這是第二行的簡要說明 */ int b; 注：不文檔化局部變量，只文檔化全局變量。注：不文檔化局部變量，只文檔化全局變量。 / /* * * * */ /這是固定格式，還要注意這是固定格式，還要注意/ /* * *這這 2 2個個“* * *”不能少也不能多。其他注釋風(fēng)不能少也不能多。其他注釋風(fēng) 格也是這樣的。格也是這樣的。 “n”“n”作用是回車換行作用是回車換行. . “brief ”是注釋指令, “”也可以 用”. 枚舉類型定義、結(jié)構(gòu)體類型定義枚舉類型定義、結(jié)構(gòu)體類型定義 枚舉類型定義、結(jié)構(gòu)體類型定

3、義注釋風(fēng)格類似。 格式： /* 簡要說明文字 */ typedef 類型 結(jié)構(gòu)體名字 成員1, /* 簡要說明文字 */ 成員2, /* 簡要說明文字 */ 成員3, /* 簡要說明文字 */ 結(jié)構(gòu)體別名； 注：所有的結(jié)構(gòu)體類型定義要放在枚舉類型定義前面。 類型：類型：enum enum ，structstruct 注意，要以 “” 小于號開頭 ，如過不 用“”，那這行的注釋就會被Doxygen 認(rèn)為是成員2的注釋。 函數(shù)定義函數(shù)定義 指令格式: 執(zhí)行符指令操作符 執(zhí)行符：或兩個。 指令操作符：param、return、retval、note、 pre、 par、code、 endcode、s

4、ee、deprecated。（其實還有很多，這里的指令操作 符已經(jīng)夠我們函數(shù)用了，所以不再列舉。） 特殊符號指令符：-、#、:。（這三符號對于我們也夠用了） Param 指令操作符講解指令操作符講解 Param：指定函數(shù)參數(shù)指令操作符。 Param 格式如下： param 參數(shù)名 參數(shù)說明 param in 參數(shù)名 參數(shù)說明 param out 參數(shù)名 參數(shù)說明 例： /* *文件關(guān)閉函數(shù) * param file文件編號。 */ int CloseFile(int file); Doxygen生成效果 return 指令操作符講解指令操作符講解 return：指定函數(shù)返回說明指令操作符。 r

5、eturn格式如下： return 簡要說明 例: /* * 寫入文件 * Param in file 文件編號 * Param in buffer 存放將要寫入的內(nèi)容 * Param in len寫入長度 * return 返回寫入的長度 * - -1 表示寫入失敗 */ int WriteFile(int file, const char* buffer, int len); retval指令操作符講解指令操作符講解 retval：指定函數(shù)返回值說明指令操作符。(注:更前面的return有點不同.這里是返回值返回值說明) retval格式如下： retval 返回值 簡要說明 例: /*

6、*文件關(guān)閉函數(shù) * param file文件編號。 * retval 0 表示成功 * retval -1 表示失敗 */ int CloseFile(int file); note 指令操作符講解指令操作符講解 note：指定函數(shù)注意項事或重要的注解指令操作符。 note格式如下： note 簡要說明 例: /* *打開文件函數(shù) *Param in name 文件名 *Param in “rb” 打開模式 *return 返回文件編號 *- -1表示打開文件失敗 *note 文件打開成功后,必須使用 CloseFile 函數(shù)關(guān)閉 */ int OpenFile(U8* file_name,

7、U8* file_mode); pre 指令操作符講解指令操作符講解 pre：指定函數(shù)前置條件指令操作符 pre格式如下： pre 簡要說明 例: /* *文件關(guān)閉函數(shù) * param file文件編號。 * retval 0 表示成功 * retval -1 表示失敗 * pre file 變量必須使用OpenFile 返回值 */ int CloseFile(int file); par指令操作符講解指令操作符講解 par：指定擴(kuò)展性說明指令操作符講。（它一般跟code、endcode一起使用 ） par格式如下： par 擴(kuò)展名字 例: /* * 打開文件函數(shù) * Param in na

8、me 文件名 * Param in “rb” 打開模式 * return 返回文件編號 * - -1表示打開文件失敗 * par 示例: * code /用文本只讀方式打開文 int f = OpenFile(”c:test.txt”, “rb”); * endcode */ int OpenFile(U8* file_name, U8* file_mode); code、endcode指令操作符講解指令操作符講解 code、endcode：指定 code、endcode格式如下： code 簡要說明(內(nèi)容) endcode 例: /* * 打開文件函數(shù) * Param in name 文件名

9、 * Param in “rb” 打開模式 * return 返回文件編號 * - -1表示打開文件失敗 * par 示例: * code /用文本只讀方式打開文 int f = OpenFile(”c:test.txt”, “rb”); * endcode */ int OpenFile(U8* file_name, U8* file_mode); see指令操作符講解指令操作符講解 see：指定參考信息。 see格式如下： see 簡要參考內(nèi)容 例: /* *文件關(guān)閉函數(shù) * param file文件編號。 * retval 0 表示成功 * retval -1 表示失敗 * pre fi

10、le 變量必須使用OpenFile 返回值 * see 函數(shù):OpenFile */ int CloseFile(int file); “:”是指定有連接功 能.可以看文檔里的 OpenFile變成綠.點 擊它可以跳轉(zhuǎn)到 OpenFile. deprecated指令操作符講解指令操作符講解 deprecated：指定函數(shù)過時指令操作符。 deprecated格式如下： deprecated 簡要說明 例: /* *文件關(guān)閉函數(shù) * param file文件編號。 * retval 0 表示成功 * retval -1 表示失敗 * deprecated 由于特殊的原因,將來的版本中取消。 */

11、 int CloseFile(int file); -、#、:指令操作符講解指令操作符講解 -：生成一個黑心圓. -#：指定按順序標(biāo)記。 :：指定連接函數(shù)功能。（注：空格和“:”有連接功能,但建議還是使用”:”。只對函數(shù)有用。） 它們格式如下: (-和:例子前面有了,就介紹-#例子。) - 簡要說明 -# 簡要說明 :函數(shù)名 例： /* * param in p 只能輸入以下參數(shù)： * -# a:代表一功能 * -# b:代表二功能 * -# c:代表三功能 */ Void Test_File(U8 p); 模塊定義（單獨顯示一頁模塊定義（單獨顯示一頁 ） 模塊定義格式: /* * defgroup 模塊名 頁的標(biāo)題名 * */ 定義的內(nèi)容 /* */ 例： /* * defgroup aa ebookmain.c * */ 定義的內(nèi)容 /* */ 模塊名只能英文,這個可以隨便取.在 一個源文件里不能相同. 跟c語言一樣起作用域功能. 分組