Doxygen 使用方式

Doxygen 是一個基於命令列的工具。在命令列中使用 doxygen 並加上 --help 選項，會顯示程式的使用簡短說明。

所有選項都以一個前導字元 - 開始，接著是一個字元，然後根據選項的不同，可能有一個或多個參數。

要為您的專案產生手冊，通常需要依照下列步驟：

1. 您使用特殊的文檔區塊記錄您的原始碼（請參閱 特殊註解區塊）。
2. 您透過使用 -g 選項呼叫 Doxygen 來產生一個組態檔（請參閱 組態）。

   doxygen -g <config_file>
   

3. 您編輯組態檔，使其符合您的專案。在組態檔中，您可以指定輸入檔案以及許多可選資訊。
4. 您讓 Doxygen 根據組態檔中的設定產生文檔。

   doxygen <config_file>
   

如果您有使用舊版 Doxygen 產生的組態檔，可以透過執行 Doxygen 並加上 -u 選項將其升級到目前版本。

doxygen -u <config_file>

原始組態檔中的所有組態設定都將複製到新的組態檔。任何新的選項都將具有其預設值。請注意，您可能在原始組態檔中加入的註解將會遺失。

微調輸出

如果您想微調輸出的外觀，Doxygen 允許您產生預設的樣式表、頁首和頁尾檔案，您可以在之後進行編輯。

• 對於 HTML 輸出，您可以使用以下命令產生預設的頁首檔案（請參閱 HTML_HEADER）、預設的頁尾（請參閱 HTML_FOOTER）和預設的樣式表（請參閱 HTML_STYLESHEET）：

  doxygen -w html header.html footer.html stylesheet.css <config_file>
  

  config_file 是可選的。如果省略，Doxygen 會搜尋名為 Doxyfile 的檔案並處理它。如果也找不到，則會使用預設設定。

• 對於 輸出，您可以使用以下命令產生 refman.tex 的第一部分和最後一部分（請參閱 LATEX_HEADER 和 LATEX_FOOTER）以及該頁首包含的樣式表（通常是 doxygen.sty）：

  doxygen -w latex header.tex footer.tex doxygen.sty <config_file>
  

  如果您需要非預設選項（例如使用額外的 套件），您需要建立一個具有正確設定這些選項的組態檔，然後在產生的檔案之後指定該組態檔（請先備份組態檔，以免忘記指定其中一個輸出檔案而遺失它）。
• 對於 RTF 輸出，您可以使用以下命令產生預設的樣式表檔案（請參閱 RTF_STYLESHEET_FILE）：

  doxygen -w rtf rtfstyle.cfg
  

警告

當使用自訂頁首時，您有責任正確包含 Doxygen 需要的任何腳本和樣式表，這取決於組態選項，並且在升級到新的 Doxygen 版本時可能會變更。

注意

• 如果您不想要組態檔中每個項目的文檔，則可以使用可選的 -s 選項。它可以與 -u 選項組合使用，以新增或移除現有組態檔中的文檔。要取得最小的組態檔，請使用 -x 或 -x_noenv 選項，以僅顯示與預設 Doxygen 組態檔的差異。如果您將組態檔作為錯誤報告的一部分傳送給我或在 GitHub 上發布問題，請使用 -s 或 -x 或 -x_noenv 選項！（另請參閱：如何報告錯誤）
• 若要讓 Doxygen 從標準輸入/輸出讀取/寫入，而不是從檔案讀取/寫入，請使用 - 作為檔案名稱。

前往下一節或返回索引。