新石器Wiki

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

現在位置: 新石器Wiki » プログラミング » Doxygen » Doxygen記述ルール

トレース:

programing:doxygen:doxygen-coding-rules-c

差分

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

この比較画面へのリンク

--- programing:doxygen:doxygen-coding-rules-c [2020/12/04 08:11] – [テーブル] 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` コマンド実行でデフォルト値ファイルが生成できる。特に下記項目について留意して設定する。
@@ 行 25: / 行 22: @@
-コメント規約ルール例
+===== コメント規約ルール例 =====
--------------------
 以下の **ファイル**，**グローバル関数**，**グローバル変数**，**来歴** のコメントについては最低限記述する。`doxygen` コマンド実行でドキュメントを生成する。
@@ 行 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コメント規約例]]

programing/doxygen/doxygen-coding-rules-c.1607037090.txt.gz · 最終更新: 2020/12/04 08:11 by yoko