簡述

該參考是基于Doxygen注釋規(guī)范進(jìn)行簡單歸納，可以適當(dāng)根據(jù)自己的需求進(jìn)行約定。

Doxygen可以從一套歸檔源文件開始，生成HTML格式的在線類瀏覽器，或離線的LATEX、RTF參考手冊。簡單來說就是一個程序的文件產(chǎn)生工具，可將程序中的特定注釋轉(zhuǎn)換成為說明文件。

注釋規(guī)范內(nèi)容

1. 簡單注釋

(1) 單行注釋

///

(2) 多行注釋

/**

2. 文件注釋

/***@file?????文件名*@brief????簡介*@datails??細(xì)節(jié)*@mainpage 工程概覽*@autor????作者*@email????郵箱*@version??版本號*@date?????年-月-日*@license??版權(quán)*/

3. 常量/變量注釋

(1)代碼前注釋

///注釋

變量/常量定義

(2)代碼后注釋

變量/常量定義 ///

4. 函數(shù)注釋

下面是函數(shù)的詳細(xì)注釋，可根據(jù)實際情況增減相關(guān)條目。

/***@brief?????函數(shù)簡介*@datail ???詳細(xì)說明**@param ????形參 參數(shù)說明*@param ????形參 參數(shù)說明*@return????返回說明*@retval????返回值說明*@note??????注解*@attention?注意*@warning ??警告*@exception異常*/

5. 其他內(nèi)容注釋

命令 生成字段名 說明

@see 參考

@class 應(yīng)用類 用于文檔生成連接

@var 引用變量 用于文檔生成連接

@enum 引用枚舉 用于文檔生成連接

@code 代碼塊開始 與@endcode成對使用

@endcode 代碼塊接收 與@code成對使用

@bug 缺陷

@todo

@example 使用例子說明

@remarks 備注說明

@pre 函數(shù)前置條件

@deprecated 函數(shù)過時說明

總結(jié)

以上是生活随笔為你收集整理的c++ doxygen 注释规范_C语言代码注释参考的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯，歡迎將生活随笔推薦給好友。