Doxygen常用命令 例項

2021-06-27 15:15:29 字數 1771 閱讀 2174

doxygen常用注釋命令 

1. 檔案資訊:

1) @file 

--> 檔案宣告,即當前檔名

2) @author 

--> 作者

3) @version --> 版本,推薦使用$id$

4) @todo 

--> 改進,可以指定針對的版本

2. 模組資訊:

1) @var 

--> 模組變數說明

2) @typedef --> 模組變數型別說明

3. 函式資訊:

1) @param 

--> 引數說明

2) @arg 

--> 列表說明引數資訊

3) @return 

--> 返回值說明

4) @retval 

--> 返回值型別說明

5) @note 

--> 註解

4. 提醒資訊:

1) @brief 

--> 摘要,即當前檔案說明

2) @see 

--> 參看

3) @attention 

--> 注意

4) @bug 

--> 問題

5) @warning 

--> 警告

6) @sa 

--> 參考資料

@code .. @endcode 包含一段**

@addtogroup 新增到乙個組。

@deprecated 已廢棄函式

@fn 

函式說明

@ingroup 加入到乙個組

@include 包含檔案

@exception 

對乙個異常物件進行注釋。

@warning  一些需要注意的事情

@todo  對將要做的事情進行注釋

@see  一段包含其他部分引用的注釋,中間包含對其他**項的名稱,自動產生對其的引用鏈結。

@relates 

通常用做把非成員函式的注釋文件包含在類的說明文件中

@since  通常用來說明從什麼版本、時間寫此部分**。

@deprecated

@pre  用來說明**項的前提條件。

@post  用來說明**項之後的使用條件。

@code 在注釋中開始說明一段**,直到@endcode命令。

@endcode 注釋中**段的結束。

一些應用例項:

多行注釋:

//! 注釋***

/// 注釋***

若要解釋前一句**:需要在注釋之後,加上'<'符號(此注釋方法只能用在class的member and function裡)

//!<

///<

乙個類或者檔案的字首注釋的常用方式:

//! @file  

檔名。

//! @brief 簡要介紹。

//! @note 詳細說明。

//! @version 版本號。

//! @author 作者名。

乙個函式注釋的常用方式:

//! @brief 簡要介紹。

//! @note 詳細說明。

//! @param[in] a:引數a說明。

//! @param[out] b:引數b說明。

//! @return 回傳值說明。

//! @retval 說明一些有特定意義的回傳值。

個人總結的小方法:

@note中換行,可以使用'\n',tab符未嘗試。但理論上應該支援。

Linux cmd常用命令 例項

1 crontab 命令 使用flock命令確保指令碼單例執行 問題的背景 我們常常需要通過crontab部署某個指令碼執行某些定時任務,但在實際的過程中,一旦處理不好可能導致在同一時刻出現指令碼的多個執行副本,比如crontab的排程是每5 分鐘執行一次指令碼,如果執行的指令碼能夠在5分鐘內處理完...

monkey常用命令例項

一 常用命令的使用 1.monkey進行壓力測試的命令是什麼呢?eg adb shell monkey p com.android.calculator 100 2.如何重現crash anr過程呢?eg adb shell monkey s 123456 p com.android.calcula...

docker常用命令 Docker 常用命令筆錄

格式docker run 選項 映象 命令 引數.示例docker run it rm ubuntu 16.04 bash 示例解釋 it 這是兩個引數,乙個是 i,表示互動式操作,乙個是 t表示終端 rm 這個引數是說容器退出後隨之將其刪除 ubuntu 16.04 這是指用ubuntu 16.0...