Doxygen極簡使用說明
阿新 • • 發佈：2017-07-07
Doxygen<?xml version="1.0" encoding="utf-8"?>
Doxygen
Table of Contents
1. Introduction
2. Syntax
2.1. 簡要描述
2.2. 函數描述
2.3. 行尾註釋
2.4. 對於生成格式的說明
3. Application
1 Introduction
Doxygen是一種開源的，跨平臺的，以類似Javadoc風格描述的文檔系統。簡單的說就是，按照一定的格式寫註釋，doxygen根據註釋生成文檔，解放程序員的工作。另外，doxygen也可以提取代碼結構，借助自動生成的包含依賴圖，繼承圖以及協作圖來可視化文檔之間的關系。
2 Syntax
2.1 簡要描述
Doxygen將下列註釋解析成簡要描述，可以用於描述宏、變量、類型等等
/**
* @brief 簡要描述
* 簡要描述
* ……
*/
2.2 函數描述
/**
* @brief 函數描述
* @param [in/out] param1 參數描述
* @note 說明
* @return 返回值描述
*/
還可以通過":: 名字"生成指向名字的超鏈接，鏈接到函數、結構等
2.3 行尾註釋
對枚舉、結構等的成員進行註釋，可以使用行尾註釋，使註釋更加緊湊
/**< 說明內容 */
2.4 對於生成格式的說明
doxygen還有對於格式的控制說明，如生成的說明是否單獨成頁，那幾個說明在一起顯示等，如果對生成的文檔有更嚴格的要求，可以自行學習這方面內容。
3 Application
doxygen -g Doxyfile :: 生成一個通用的配置文件
編輯生成的配置文件，其中有幾個選項是必填的
<OUTPUT_DIRECTORY>
生成文檔的目錄
<INPUT>
源代碼目錄
<RECURSIVE>
是否需要遞歸解析源代碼目錄，一般配置成Yes
<EXTRACT_ALL>
是否提取沒有註釋的函數信息
<EXTRACT_PRIVATE>
是否提取私有數據成員，一般配置成Yes
<EXTRACT_STATIC>
是否提取靜態成員
還有幾個跟生成格式相關的選項，包括html，chm，rtf等，一般都是選上的，不用管。
doxygen Doxyfile :: 根據配置文件生成文檔
Author: zhangkai
Created: 2017-07-06 四 12:07
Emacs 24.5.1 (Org mode 8.2.10)
Doxygen
Table of Contents
1. Introduction
2. Syntax
2.1. 簡要描述
2.2. 函數描述
2.3. 行尾註釋
2.4. 對於生成格式的說明
3. Application
1 Introduction
Doxygen是一種開源的，跨平臺的，以類似Javadoc風格描述的文檔系統。簡單的說就是，按照一定的格式寫註釋，doxygen根據註釋生成文檔，解放程序員的工作。另外，doxygen也可以提取代碼結構，借助自動生成的包含依賴圖，繼承圖以及協作圖來可視化文檔之間的關系。
2 Syntax
2.1 簡要描述
Doxygen將下列註釋解析成簡要描述，可以用於描述宏、變量、類型等等
/**
* @brief 簡要描述
* 簡要描述
* ……
*/
2.2 函數描述
/**
* @brief 函數描述
* @param [in/out] param1 參數描述
* @note 說明
* @return 返回值描述
*/
還可以通過":: 名字"生成指向名字的超鏈接，鏈接到函數、結構等
2.3 行尾註釋
對枚舉、結構等的成員進行註釋，可以使用行尾註釋，使註釋更加緊湊
/**< 說明內容 */
2.4 對於生成格式的說明
doxygen還有對於格式的控制說明，如生成的說明是否單獨成頁，那幾個說明在一起顯示等，如果對生成的文檔有更嚴格的要求，可以自行學習這方面內容。
3 Application
doxygen -g Doxyfile :: 生成一個通用的配置文件
編輯生成的配置文件，其中有幾個選項是必填的
<OUTPUT_DIRECTORY>
生成文檔的目錄
<INPUT>
源代碼目錄
<RECURSIVE>
是否需要遞歸解析源代碼目錄，一般配置成Yes
<EXTRACT_ALL>
是否提取沒有註釋的函數信息
<EXTRACT_PRIVATE>
是否提取私有數據成員，一般配置成Yes
<EXTRACT_STATIC>
是否提取靜態成員
還有幾個跟生成格式相關的選項，包括html，chm，rtf等，一般都是選上的，不用管。
doxygen Doxyfile :: 根據配置文件生成文檔
Author: zhangkai
Created: 2017-07-06 四 12:07
Emacs 24.5.1 (Org mode 8.2.10)
北京激光祛斑：www.6ysh.com
Doxygen極簡使用說明