差分

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

--- programing:doxygen:doxygen-coding-rules-c [2020/04/16 00:51] – [ファイル内関数・コメント] yoko
+++ programing:doxygen:doxygen-coding-rules-c [2020/12/03 23:11] (現在) – [テーブル] yoko
@@ 行 15: / 行 15: @@
 設定ファイル「`Doxyfile`」は、`doxygen -g` コマンド実行でデフォルト値ファイルが生成できる。特に下記項目について留意して設定する。
-^ 必須  ^ 設定項目                     ^ 設定値                     ^ 備考                                             ^
+^ 必須  ^ 設定項目                 ^ 設定値                ^ 備考                                                                            ^
-| ◎   | `PROJECT_NAME`           | `"μNETマスター通信 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にする）       |
@@ 行 50: / 行 50: @@
  *****************************************************************************
  * @brief  Sample main program
- * @param[in] argc 引数の個数
+ * @param  argc 引数の個数
- * @param[in] argv 引数文字列
+ * @param  argv 引数文字列
- * @return 終了コード
+ * @retval 0 正常
+ * @retval 1 引数エラー
  * @details
  *****************************************************************************
@@ 行 61: / 行 62: @@
 </code>
-  * 戻り値は数値を指定せず「`@return =0:正常, =-1:異常`」などのように簡単に記述してもよい。
+  * 戻り値は`retval`で数値を指定せず「`@return =0:正常, =-1:異常`」などのように簡単に記述してもよい。
   * `@attention`の注意事項は無ければ省略する。
   * 引数と戻り値がない時は「`none`」と記述する。
@@ 行 73: / 行 74: @@
 /**
  * @brief  サブルーチン関数
- * @param[in] mode モード指定(0 or 1)
+ * @param  mode モード指定(0 or 1)
- * @return 実行結果（=0:正常, ≠0:エラー）
+ * @return 終了コード（=0:正常, ≠0:エラー）
  * @details
  *  - modeが不正な時は「-1」が戻る
@@ 行 87: / 行 88: @@
 <code c>
-T_MYTBL _mytbl[256];	//!< 管理テーブル
+T_MYTBL _mytbl[16];	//!< 管理テーブル
 </code>
@@ 行 108: / 行 109: @@
   * `@file`の記述がキーとなるので、先頭に記述したファイル名と必ず一致するようにする。
-  * 最低限以下の情報は記載する事。細かい変更はGitで管理できる。
+  * 最低限以下の情報は記載する。細かい変更はGitで管理できる。
 「新規作成日・作成者」，「大きな機能変更」，「大きなバグ修正」
@@ 行 140: / 行 141: @@
   * 説明文の記述には[[http://kasamotokun.endless-world.net/doxygen-manual/markdown.html|Markdown]]記法が使える。なので、「`## `」で見出し，「`- `」文字で箇条書き になる。
-  * その他にも色々なコマンドがあるの。
+  * その他にも色々なコマンドがある。