Doxygen備忘
下載與安裝
一般步驟
- 生成配置文件Doxyfile:
doxygen (-s) -g - 建立目錄結構, 比如Doxyfile文件\doc文件夾(輸出)\src文件夾(放代碼) ->三者在同一目錄下
- 根據情況設置配置文件中的參數(關鍵)
- 運行
doxygen Doxyfile生成大概結構 - 針對每個代碼文件寫doxygen注釋
- 繼續運行
doxygen Doxyfile
配置文件Doxyfile設置
DOXYFILE_ENCODING = UTF-8
PROJECT_NAME = "Project Name"
PROJECT_NUMBER = 1.0
PROJECT_BRIEF = "This is a brief descript."
EXTRACT_ALL = YES
OUTPUT_DIRECTORY = "./doc"
OUTPUT_LANGUAGE = Chinese
FULL_PATH_NAMES = NO
WARN_LOGFILE ="./doc/build.log"
INPUT ="./src"
FILE_PATTERNS =
SOURCE_BROWSER = NO
GENERATE_LATEX = NO
CALL_GRAPH = YES
CALLER_GRAPH = YES
UML_LOOK = YES
RECURSIVE = YES
各種注釋規范
文件注釋
/**
* Copyright (c) 2017, All rights reserverd.
*
* @file $file$
* @brief $brief$
* Details.
*
* @author $author$,$email$
* @date $yy$-$mm$-$dd$
* @version $maj$.$min$
*
*************************************************/
命名空間
/**
* @brief $brief$
* Details.
**/
結構體\枚舉
/**
* @brief $brief$
* Details.
**/
類注釋
/**
* @brief $brief$
* Details.
**/
成員變量注釋
- 在變量上面加
/** 成員變量描述 */ - 在變量后面加
/**<成員變量描述 */
函數注釋
/**
* @brief $brief$-$test$
* Details.
* @param $param1$ : $param1_detail$
* @param $param2$ : $param2_detail$
* @return $return_detail$
* -<em>false</em> fail
* -<em>true</em> succeed
* @retval $return_note$
* @deprecated $deprecated$
* @see $see$
* @pre $pre$
**/
備注:
-
note：指定函數注意項事或重要的注解指令操作符
note格式如下：
@note 簡要說明 -
retval：指定函數返回值說明指令操作符。(注:更前面的return有點不同.這里是返回值說明)
retval格式如下：
@retval 返回值 簡要說明 -
pre：指定函數前置條件指令操作符
pre格式如下：
@pre 簡要說明 -
par：指定擴展性說明指令操作符講。（它一般跟code、endcode一起使用 ）
par格式如下：
@par 擴展名字 -
code、endcode：指定
code、endcode格式如下：
@code
簡要說明(內容)
@endcode -
see：指定參考信息。
see格式如下：
@see 簡要參考內容 -
deprecated：指定函數過時指令操作符。
deprecated格式如下：
@deprecated 簡要說明
調試Bug說明
解決的bug說明，@bug
警告說明 (warning)
定義一些關於這個函數必須知道的事情，@warning
備注說明 (remarks)
定義一些關於這個函數的備注信息，@remarks
將要完成的工作 (todo)
說明哪些事情將在不久以后完成，@todo
使用例子說明 (example)
例子說明，@example example.cpp
關鍵字收集
@author 作者
@brief 摘要
@version 版本號
@date 日期
@file 文件名，可以默認為空，DoxyGen會自己加
@class 類名
@param 函數參數
@return 函數返回值描述
@exception 函數拋異常描述
@warning 函數使用中需要注意的地方
@remarks 備注
@see see also字段
@note brief下空一行后的內容表示詳細描述，但也可以不空行用note表示
@par 開始一個段落，段落名稱描述由你自己指定，比如可以寫一段示例代碼
@code 引用代碼段
@endcode 引用代碼段結束
@pre 函數前置條件，比如對輸入參數的要求
@post 函數后置條件，比如對系統狀態的影響或返回參數的結果預期
@param[in|out] 參數名及其解釋
@exception 用來說明異常類及拋出條件
@return 對函數返回值做解釋
@note 表示注解，暴露給源碼閱讀者的文檔
@remark 表示評論，暴露給客戶程序員的文檔
@since 表示從那個版本起開始有了這個函數
@deprecated 引起不推薦使用的警告
@see 表示交叉參考