タグ

2021年11月4日のブックマーク (1件)

  • SAKURA Editor / Wiki / DoxygenComment

    開発に参加したい方へ>doxygen>コメントの書き方 コメントの書き方(クラス・関数のコメント) ソースコード中のコメントをdoxygenの解説に反映させるためのコメントの書き方です。新規にコメントを入れる場合は以下のルールにできるだけ従うようにしてください。 関数内のコメントはこのルールに従っていただいても意味がありませんので通常のコメントで結構です。ドキュメント生成に関係するのは、 ファイル クラス メンバー関数(Inline含む) メンバー変数 グローバル変数 クラスのメンバーでない関数 定数宣言 (#define, enum) です。 doxygenで認識されるコメント スタイル doxygenではQtスタイル及びJavaDocスタイルのコメントを認識します.コメントには要約説明(クラス一覧やクラスメンバーのサマリー部にも表示されるもの)と詳細説明(各関数の説明部のみに出力される