doxygen標(biāo)準(zhǔn)VC注釋配置步驟

1、 C+ 程序文檔生成器介紹(doxygen)/* */ / 模塊結(jié)尾2. 分組定義（在一頁內(nèi)分組顯示）* name 分組說明文字 * - r 讀取* - w 可寫* - a 添加 typedef enum TDayOfWeek/brief class of server socket.private:public: int accept_client(const int listenfd);# 行尾的注釋,格式: / 注釋內(nèi)容.int child_pipefd; /parents stream pipe to/from child.;pid_t g_pid = 0; Example End #

2、 Staff_TPC 是生成文檔的項(xiàng)目名,會顯示在文檔中.OUTPUT_LANGUAGEJAVADOC_AUTOBRIEF= YES # 打開此選項(xiàng). # 輸入文件的匹配模式,下面是 c / c+語言的設(shè)置.*.hppRECURSIVE= YES # 需要遞歸處理子目錄.SOURCE_BROWSERINLINE_SOURCESSTRIP_CODE_COMMENTS = YES # 忽略普通的文檔注釋.REFERENCED_BY_RELATION = YESVERBATIM_HEADERS#GENERATE_HTMLGENERATE_HTMLHELP閱讀.= YES # 需要生成 html 格式

3、的文檔.#GENERATE_LATEX = NO # 不需要生成 LaTeX 輸出.# dot 選項(xiàng) # 此選項(xiàng)是生成圖形,建議(需要)安裝 graphviz.#CLASS_DIAGRAMSHAVE_DOT= YES # 已經(jīng)安裝 graphviz.打開此選項(xiàng).= YES # 生成類圖 a. mouse move eventb. mouse click eventMore info about the click event.c. mouse double click event * author 沐楓* version 1.0#define DATA_FILENAME d:datadetai

4、l.dat/* 存檔文件名 */#define BAK_FILENAME d:databackup.dat#define SYS_WARNNING 2/* */ / 系統(tǒng)狀態(tài)常量typedef enum TDayOfWeekSUN = 0, /* 星期天 */MON = 1, /* 星期一 */TUE = 2, /* 星期二 */WED = 3, /* 星期三 */ THU = 4, /* 星期四 */FRI = 5, /* 星期五 */SAT = 6 /* 星期六 */* 定義類型 TEnumDayOfWeek */* defgroup FileUtils 文件操作函數(shù)* 打開文件 n* n

5、ote 文件打開成功后，必須使用 :CloseFile 函數(shù)關(guān)閉* par 示例: int OpenFile(const char* file_name, const char* file_mode);* paramin file 文件編號，參見：:OpenFile* paramout buffer 用于存放讀取的文件內(nèi)容* paramin len 需要讀取的文件長度* return 返回讀取文件的長度* - -1 表示讀取文件失敗* pre e file 變量必須使用 :OpenFile 返回值* pre e buffer 不能為 NULL* 寫入文件* pre e file 變量必須使用

6、:OpenFile 返回值* see :OpenFile :ReadFile :CloseFile*/int WriteFile(int file, const char* buffer, int len);int CloseFile(int file);/* */ / 文件操作函數(shù) 生成的 chm 文檔截圖： 簡介 DoxygenC/C+JavaLaTeX 安裝 Doxygen 設(shè)定 Project 的 doxygen 組態(tài)Project 的名字，以一個(gè)單字為主，多個(gè)PROJECT_VERSION Project的版本號碼。輸出路徑。產(chǎn)生的文件會放在這個(gè)路徑之下。如果沒有填這個(gè)路徑，將會以目

7、前所在路徑來作為輸出路徑。 如果您的 INPUT Tag 中指定了目錄。您可以透過這個(gè) Tag來要求 Doxygen在處理時(shí)，只針對特定的檔案進(jìn)行動作。例如：您希望對目錄下的擴(kuò)展名為.c, .cpp及.h的檔案作處理。您可設(shè)定 FILE_PATTERNS = *.c,*.cpp, *.h。如果您有某幾個(gè)特定檔案或是目錄，不希望經(jīng)過 Doxygen處理。您可在這個(gè) Tag中指定。件的列表，以供查閱。如果設(shè)定為 YES ，則程序代碼也會被嵌入表會加入在產(chǎn)生的文件中。HTML文件的輸出目錄。這是一個(gè)相對路徑，所以實(shí)際的路徑為OUTPUT_DIRECTORY加上HTML_OUTPUT。這個(gè)設(shè)定預(yù)設(shè)為h

8、tml。 設(shè)定為 YES 時(shí)，會產(chǎn)生 LaTeX 的文件。不過您的系統(tǒng)必需要有安裝 LaTeX 的相關(guān)工具。LaTeX程序的命令名稱及檔案所在。預(yù)設(shè)為latex。與 HTML_OUTPUT 用法相同，用來指定 RTF輸出檔案路徑。預(yù)設(shè)為 rtf。若設(shè)定為YES ，則會產(chǎn)生Unix Man Page 格與 HTML_OUTPUT 用法相同，用來指定 ManPage的輸出目錄。預(yù)設(shè)為 man?？梢宰屇孕卸x一些宏。類似于 gcc 中的-D選項(xiàng)。 /*! . 批注 . */* . 批注 . */! . 批注 ./ . 批注 . void member_function();* 我的自訂類別說明 .

9、*/int member1 ; / 第一個(gè) member說明 .int member2: / 第二個(gè) member說明 .int member_function(int a, int b);* param a 參數(shù) a的說明* param b 參數(shù) b的說明int MyClass:member_function( int a, int b ) 后面接函數(shù)傳回值的說明。用于 function的* 這個(gè)檔案只定義 example這個(gè) class。* 本范例說明 Example class。 int var1 ; / 這是一個(gè) private的變數(shù)public:int var2 ; / 這是一個(gè) p

10、ublic的變數(shù)成員。int var3 ; / 這是另一個(gè) public的變數(shù)成員。void ExFunc1(void);* 這個(gè)檔案用來定義 example這個(gè) class的* ExFunc3()傳回兩個(gè)參數(shù)相加的值。* param b 用來相加的參數(shù)。* return 傳回兩個(gè)參數(shù)相加的結(jié)果。 * ExFunc3()只傳回參數(shù)輸入的指標(biāo)。制作說明文件 Doxygen完整的配置步驟編寫 bat3. Doxyfile 主要參數(shù)說明4. 注釋格式和規(guī)范 DBG_MENU_WIDTHCTRL_MENU_UP = 0, /菜單項(xiàng)向上按鈕CTRL_MENU_DOWN, /菜單項(xiàng)向下按鈕CTRL_MEN

11、U_LEFT, /菜單項(xiàng)向左按鈕CTRL_MENU_OK,CTRL_MENU_END/菜單項(xiàng)確認(rèn)按鈕/菜單項(xiàng)結(jié)束，自定義項(xiàng)目開始，不直接使用類，成員變量，成員函數(shù)/ brief Debug項(xiàng)調(diào)整器 / brief 獲取是否有效。GetActive(void) const;/ brief 設(shè)置列寬。SetColWidth(int width);/ brief 設(shè)置行高。SetRowHeight(int height);FindData(const string& name);/ brief 清除指定名字(name)的數(shù)據(jù)。/ return 如果不存在則返回 false。RemoveData(const string& name); bool/ 當(dāng)前指向的索引值int m_Index;/ 顯示用列寬g_DbgManager.Update();g_DbgManager.Render();/ / endcode 工程代碼管理流程TortoiseSVN-5855-win32-svn-1.6.0.msi選項(xiàng) 測試學(xué)習(xí)工程-沙盤工程-test 工程：/svn/trunk/神經(jīng)網(wǎng)絡(luò)工程-目標(biāo)分割-a 工程 ：kalman 濾波器工程-小目標(biāo)識別-b