1. 程式人生 > >Ubuntu16.04安裝與使用Doxygen

Ubuntu16.04安裝與使用Doxygen

1 安裝Doxygen

sudo apt-get install doxygen
2 安裝Graphviz

    根據參考資料[7]的提示,Doxygen使用Graphviz這個工具來繪圖:

sudo apt-get install graphviz

3 標籤命令關鍵字[21]
3.1 檔案資訊
  1) @file 檔名(遵守檔案命名規則) --> 檔案宣告,即當前檔名
  2) @author 作者名 --> 作者
  3) @version 版本號 --> 版本號
  4) @todo 說明文字 --> TODO 列表,在相關頁面有它專門一項
  注:只能在實現檔案(*.c/*.cpp)中使用,
    如果相同函式的實現檔案與標頭檔案中均有,生成的文件中會有重複項,
    可以理解為呼叫者不應知道實現流程。
  5) @date 日期時間 --> 說明檔案生成的日期時間
  6) @section 章節標題 --> @section LICENSE 版權許可 @section DESCRIPTION 描述
3.2 模組資訊:
  1) @defgroup 模組名(英文) 顯示名(中文) @{ 類/函式/變數/巨集/... @}--> 定義模組
  2) @ingroup 模組名(英文) [顯示名(中文)]--> 作為指定名的模組的子模組,顯示名為可選項,
                         可與指定名的模組的顯示名不同。
  3) @addtogroup 模組名(英文) [顯示名(中文)] --> 作為指定名的模組的成員,顯示名為可選項,
                           必需與指定名的模組的顯示名相同。
  4) @name 顯示名(中文) @{ 變數/巨集 @} --> 按用途分,以便理解全域性變數/巨集的用途
3.3 函式資訊:
  1) @param 引數名 說明文字 --> 不建議使用這個
      @param[in] 引數名 說明文字 --> 輸入引數
      @param[out] 引數名 說明文字 --> 輸出引數
      @param[in,out] 引數名 說明文字 --> 即輸入又輸出引數
  2) @arg 引數/返回值 說明文字 --> 以列表形式說明引數取值意義
    注:也可以用 - 或 -# 來代替,建議此種方法,簡單明瞭。
      - 第一級
       - 第二級
        - 第三級
      即相同開頭的 - 或 -# 第二行比第一行縮排一個英文空格就變了第二級,依次類推。
      - 開頭的第一級為實心黑圓點;第二級為空心黑圓點;第三級以後為實心方塊;
      -# 開頭的第一級為數字(1./2./3./...),
           第二級為小寫字母(a./b./c./...),
           第三級為羅馬數字(i./ii./iii./...),
           第四級為大寫字母(A./B./C./...)
  3) @return 說明文字 --> 返回值說明
  4) @retval 說明文字 --> 特定返回值說明
  5) @note 說明文字 --> 註解,可以描述工作流程和注意事項
  6) @par [段落標題] --> 開創新段落,一般與示例程式碼聯用
  7) @code --> 示例程式碼開始
  8) @endcode --> 示例程式碼結束
  9) @see 類/函式/變數/檔案/URL --> 參見,
      類名::函式名 或 ::函式名 可以變成超連結點選跳轉到對應函式說明處
      函式過載的情況下,要帶上引數列表以及返回值
  10) @deprecated 說明文字 --> 過時列表,在相關頁面有它專門一項,
      注:只能在標頭檔案(*.h)中使用,如果相同函式的實現檔案與標頭檔案中均有,
        生成的文件中會有重複項,可以理解為維護者不關心這個介面是不是要過時。
  11) @pre 說明文字 --> 前置條件
3.4 提醒資訊:
  1) @brief 說明文字 --> 摘要,即當前檔案/函式說明
  2) @attention 說明文字 --> 注意
  3) @bug 說明文字 --> 問題
  4) @warning 說明文字 --> 警告

參考資料