新石器Wiki

近年はシリコン(石)から進化した便利なもので溢れる時代。そんな気になった事や試した事など記す。

ユーザ用ツール

サイト用ツール

現在位置: 新石器Wiki » プログラミング » Doxygen » Doxygen記述ルール
トレース:
programing:doxygen:doxygen-coding-rules-c


差分

このページの2つのバージョン間の差分を表示します。

この比較画面へのリンク

両方とも前のリビジョン前のリビジョン
次のリビジョン		前のリビジョン
programing:doxygen:doxygen-coding-rules-c [2020/07/21 12:55] – [テーブル] yokoprograming:doxygen:doxygen-coding-rules-c [2026/07/28 13:16] (現在) – 外部編集 127.0.0.1
行 1: 行 1:
-Doxygen記述ルール +====== Doxygen記述ルール ======
-=================+
 C/C++言語のソースを記述例について説明。 C/C++言語のソースを記述例について説明。
  
-Doxygen文法マニュアル +===== Doxygen文法マニュアル =====
---------------------+
 「[[http://www.doxygen.jp/manual.html|Doxygen マニュアル]]」の特に下記ページを参照。 「[[http://www.doxygen.jp/manual.html|Doxygen マニュアル]]」の特に下記ページを参照。
  
行 11: 行 9:
   * [[http://kasamotokun.endless-world.net/doxygen-manual/markdown.html|Markdownサポート]]   * [[http://kasamotokun.endless-world.net/doxygen-manual/markdown.html|Markdownサポート]]
  
-Doxygen設定項目 +===== Doxygen設定項目 =====
---------------+
 設定ファイル「`Doxyfile`」は、`doxygen -g` コマンド実行でデフォルト値ファイルが生成できる。特に下記項目について留意して設定する。 設定ファイル「`Doxyfile`」は、`doxygen -g` コマンド実行でデフォルト値ファイルが生成できる。特に下記項目について留意して設定する。
  
-^ 必須  ^ 設定項目                     ^ 設定値               ^ 備考                                             ^ +^ 必須  ^ 設定項目                 ^ 設定値                ^ 備考                                                                            ^ 
-| ◎   | `PROJECT_NAME`           | `"サンプル Project"`  | プロジェクト名またはプログラム名を記述する                          | +| ◎     | `PROJECT_NAME`           | `"サンプル Project"`  | プロジェクト名またはプログラム名を記述する                                      | 
-| ◎   | `OUTPUT_LANGUAGE`        | `Japanese`        | 日本語出力する                                        | +| ◎     | `OUTPUT_LANGUAGE`        | `Japanese`            | 日本語出力する                                                                  | 
-| ◎   | `OPTIMIZE_OUTPUT_FOR_C`  | `YES`             | C/C++言語ではYESに設定                                | +| ◎     | `OPTIMIZE_OUTPUT_FOR_C`  | `YES`                 | C/C++言語ではYESに設定                                                          | 
-|     | `PROJECT_NUMBER`         | `1.1`             | バージョン情報が必要であれば記述する                             | +|       | `PROJECT_NUMBER`         | `1.1`                 | バージョン情報が必要であれば記述する                                            | 
-| ○   | `RECURSIVE`              | `NO` or `YES`     | `YES`にするとDoxygen実行ディレクトリ以下を再帰的に探してドキュメントを生成する  | +| △     | `RECURSIVE`              | `NO` or `YES`         | `YES`にするとDoxygen実行ディレクトリ以下を再帰的に探してドキュメントを生成する  | 
-|     | `GENERATE_LATEX`         | `NO`              | LaTeX出力をしない（時間がかかるので、通常は抑制し、必要時にYESにする）        | +|       | `GENERATE_LATEX`         | `NO`                  | LaTeX出力をしない（時間がかかるので、通常は抑制し、必要時にYESにする）          | 
-|     | `HAVE_DOT`               | `NO`              | graphvizを使用しない（時間がかかるので、通常は抑制し、必要時にYESにする）     |+|       | `HAVE_DOT`               | `NO`                  | graphvizを使用しない（時間がかかるので、通常は抑制し、必要時にYESにする）       |
  
  
-コメント規約ルール例 +===== コメント規約ルール例 =====
--------------------+
 以下の **ファイル**，**グローバル関数**，**グローバル変数**，**来歴** のコメントについては最低限記述する。`doxygen` コマンド実行でドキュメントを生成する。 以下の **ファイル**，**グローバル関数**，**グローバル変数**，**来歴** のコメントについては最低限記述する。`doxygen` コマンド実行でドキュメントを生成する。
  
行 113: 行 109:
  
  
-その他のコメント +===== その他のコメント =====
----------------+
  
 ### 覚え書き ### 覚え書き
行 137: 行 132:
 </code> </code>
  
-補足 +===== 補足 =====
-----+
  
   * 説明文の記述には[[http://kasamotokun.endless-world.net/doxygen-manual/markdown.html|Markdown]]記法が使える。なので、「`## `」で見出し，「`- `」文字で箇条書き になる。   * 説明文の記述には[[http://kasamotokun.endless-world.net/doxygen-manual/markdown.html|Markdown]]記法が使える。なので、「`## `」で見出し，「`- `」文字で箇条書き になる。
行 144: 行 138:
  
  
-参考 +===== 参考 =====
-----+
  
-1. [[http://www.02.246.ne.jp/~torutk/cxx/doxygen/doxygenstyles.html|Doxygenコメント規約例]]+  - [[http://www.02.246.ne.jp/~torutk/cxx/doxygen/doxygenstyles.html|Doxygenコメント規約例]]
  
  
programing/doxygen/doxygen-coding-rules-c.1595303705.txt.gz · 最終更新: by yoko