このブログは、旧・はてなダイアリー「檜山正幸のキマイラ飼育記 メモ編」(http://d.hatena.ne.jp/m-hiyama-memo/)のデータを移行・保存したものであり、今後(2019年1月以降)更新の予定はありません。

今後の更新は、新しいブログ http://m-hiyama-memo.hatenablog.com/ で行います。

メンバーのグルーピング

やっと、わかった。クラス内のメンバーをグルーピングするには、次のようにする。

    //--------------------------------------------------
    /*! @name 見出しは日本語でOK
      必要があればここにもコメントできる。
     */
    //--------------------------------------------------
    //! @{

    // ここに何やらかにやら

    //!@}

あるいは、

    //--------------------------------------------------
    /*! @name 見出しは日本語でOK
     @{
     */
    //--------------------------------------------------
    // ここに何やらかにやら
    //!@}

原則は:

  1. グループの開始を '@{' ディレクティブで示す。
  2. グループの終了を '@}' ディレクティブで示す。
  3. グループ開始の直前のドキュメンテーションコメントは、そのグループに対するコメントとみなされる。
  4. このとき、@name ディレクティブが必要で、@nameの直後の文字列がグループの見出しとなる。
  5. @name がないグループにはコメントを付けられないし、グループ化は一応されるが目視では分かりにくい。
  6. グルーピングはメンバ一覧にしか影響しない。詳細説明にはグルーピングが効いてこない。

グルーピングを使うと、どのグループにも属してないメンバーが最初に列挙されることになる。これはかなり違和感があるので、やるならすべてのメンバーをグルーピングすることになるだろう。