差分

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

--- programing:doxygen:doxygen-coding-rules-c [2020/04/16 10:05] – yoko
+++ programing:doxygen:doxygen-coding-rules-c [2026/07/28 13:16] (現在) – 外部編集 127.0.0.1
@@ 行 1: / 行 1: @@
-Doxygen記述ルール
+====== Doxygen記述ルール ======
-=================
 C/C++言語のソースを記述例について説明。
-Doxygen文法マニュアル
+===== Doxygen文法マニュアル =====
---------------------
 「[[http://www.doxygen.jp/manual.html|Doxygen マニュアル]]」の特に下記ページを参照。
@@ 行 11: / 行 9: @@
   * [[http://kasamotokun.endless-world.net/doxygen-manual/markdown.html|Markdownサポート]]
-Doxygen設定項目
+===== Doxygen設定項目 =====
---------------
 設定ファイル「`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` コマンド実行でドキュメントを生成する。
@@ 行 50: / 行 46: @@
  *****************************************************************************
  * @brief  Sample main program
- * @param[in] argc 引数の個数
+ * @param  argc 引数の個数
- * @param[in] argv 引数文字列
+ * @param  argv 引数文字列
- * @return 終了コード（=0:正常, ≠0:エラー）
+ * @retval 0 正常
+ * @retval 1 引数エラー
  * @details
  *****************************************************************************
@@ 行 61: / 行 58: @@
 </code>
-  * 戻り値は数値を指定せず「`@return =0:正常, =-1:異常`」などのように簡単に記述してもよい。
+  * 戻り値は`retval`で数値を指定せず「`@return =0:正常, =-1:異常`」などのように簡単に記述してもよい。
   * `@attention`の注意事項は無ければ省略する。
   * 引数と戻り値がない時は「`none`」と記述する。
@@ 行 73: / 行 70: @@
 /**
  * @brief  サブルーチン関数
- * @param[in] mode モード指定(0 or 1)
+ * @param  mode モード指定(0 or 1)
- * @retval 0 正常
+ * @return 終了コード（=0:正常, ≠0:エラー）
- * @retval ≠0 エラー
  * @details
  *  - modeが不正な時は「-1」が戻る
@@ 行 113: / 行 109: @@
-その他のコメント
+===== その他のコメント =====
----------------
 ### 覚え書き
@@ 行 137: / 行 132: @@
 </code>
-補足
+===== 補足 =====
-----
   * 説明文の記述には[[http://kasamotokun.endless-world.net/doxygen-manual/markdown.html|Markdown]]記法が使える。なので、「`## `」で見出し，「`- `」文字で箇条書き になる。
@@ 行 144: / 行 138: @@
-参考
+===== 参考 =====
-----
-. [[http://www.02.246.ne.jp/~torutk/cxx/doxygen/doxygenstyles.html|Doxygenコメント規約例]]
+  - [[http://www.02.246.ne.jp/~torutk/cxx/doxygen/doxygenstyles.html|Doxygenコメント規約例]]