Doxygen可以從一套歸檔源文件開始,生成HTML格式的在線類瀏覽器,或離線的LATEX、RTF參考手冊。簡單來說就是一個程序的文件產生工具,可將程序中的特定注釋轉換成為說明文件。
注釋規范內容
1.簡單注釋
(1)單行注釋
///
(2)多行注釋
/**
2.文件注釋
/**
*@file文件名
*@brief簡介
*@datails細節
*@mainpage工程概覽
*@autor作者
*@email郵箱
*@version版本號
*@date年-月-日
*@license版權
*/
3.常量/變量注釋
(1)代碼前注釋
///注釋
變量/常量定義
(2)代碼后注釋
變量/常量定義///<注釋
4.函數注釋
下面是函數的詳細注釋,可根據實際情況增減相關條目。
/**
*@brief函數簡介
*@datail詳細說明
*
*@param形參參數說明
*@param形參參數說明
*@return返回說明
*@retval返回值說明
*@note注解
*@attention注意
*@warning警告
*@exception異常
*/
5.其他內容注釋
命令生成字段名說明
@see參考
@class應用類用于文檔生成連接
@var引用變量用于文檔生成連接
@enum引用枚舉用于文檔生成連接
@code代碼塊開始與@endcode成對使用
@endcode代碼塊接收與@code成對使用
@bug缺陷
@todo
@example使用例子說明
@remarks備注說明
@pre函數前置條件
@deprecated函數過時說明