> For the complete documentation index, see [llms.txt](https://yutakatay.gitbook.io/katapedia/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://yutakatay.gitbook.io/katapedia/doc/doxygenkomento.md).

# Doxygenコメント規約

* 極力@xxxを使用せずともわかる方がよい
* ファイルヘッダ

  \~\~\~ /\*!
* Copyright

  \*

  \*/

  \~\~\~
* 関数ヘッダ

  \~\~\~

  /\*!
* get\_ret

  \*
* @param\[in]  varname 説明
* @return 結果の数 \*/

  \~\~\~
* クラスヘッダ

  \~\~\~ /\*!
* ファイルコメント参照。

  \*
* ファイルコメント参照。 \*/

  \~\~\~
* 構造体

  \~\~\~ /\*!
* It's a struct. \*/

  \~\~\~
* グローバル変数

  \~\~\~ /\*!
* @var   global\_var1
* グローバル変数の説明 \*/

  \~\~\~
* 列挙型

  \~\~\~ /\*!
* 列挙型の説明 \*/

  \~\~\~
* コメント

  ```
  /*! 複数行コメント */
  //! 単数行コメント
  //!< 追加コメント
  ```
* ページヘッダ

  \~\~\~

  /\*! @mainpage planchkproc

  \*
* @section 概要

  \*
* S02015用中継器設定情報ファイルフォーマットチェックツール

  \*
* @section 詳細
* フォーマットをチェックする

  \*
* @subsection 背景
* S02015で受け取る中継器設定情報ファイルがでたらめである可能性が発生したため

  \*

  \*/

  \~\~\~