メンバーのグルーピング
やっと、わかった。クラス内のメンバーをグルーピングするには、次のようにする。
//-------------------------------------------------- /*! @name 見出しは日本語でOK 必要があればここにもコメントできる。 */ //-------------------------------------------------- //! @{ // ここに何やらかにやら //!@}
あるいは、
//-------------------------------------------------- /*! @name 見出しは日本語でOK @{ */ //-------------------------------------------------- // ここに何やらかにやら //!@}
原則は:
- グループの開始を '@{' ディレクティブで示す。
- グループの終了を '@}' ディレクティブで示す。
- グループ開始の直前のドキュメンテーションコメントは、そのグループに対するコメントとみなされる。
- このとき、@name ディレクティブが必要で、@nameの直後の文字列がグループの見出しとなる。
- @name がないグループにはコメントを付けられないし、グループ化は一応されるが目視では分かりにくい。
- グルーピングはメンバ一覧にしか影響しない。詳細説明にはグルーピングが効いてこない。
グルーピングを使うと、どのグループにも属してないメンバーが最初に列挙されることになる。これはかなり違和感があるので、やるならすべてのメンバーをグルーピングすることになるだろう。