クラス宣言の書き方

http://d.hatena.ne.jp/m-hiyama-memo/20160510/1462863099:tileのグルーピングを使うことを前提にする。

1. @nameディレクティブの引数は、日本語でも特殊文字でもいい。nameというよりむしろtitle
2. @name、@{、@} の3つを使う。
3. ソースのフォーマティングのために、//------- とか //======= を適宜はさんでよい。横線の長さは、例えば50とかに決めておく。
4. 実装者観点では、最初にprivateメンバーを置きたくなるが、利用者観点では最初がpublic。

//! 1行の短い説明
/*!

より詳しい説明

 */
class Foo
{
public:

    //! 構築子
    Foo(void);
    //! 解体子
    virtual ~Foo(void);

    //--------------------------------------------------
    /*! @name 問い合わせメソッド
      あれば詳しい説明
     */
    //--------------------------------------------------
    //! @{

    //! ナントカを返す
    const char* GetFooBar(void) const;

    // ...
    
    //!@}
    
    //--------------------------------------------------
    //! @name 変更メソッド
    //--------------------------------------------------
    //!@{

    //! ナントカにカントカをセットする
    void SetHoge
    (
     const char* name,  //!< 名前
     // ...
     );

     //!@}

protected:
    //! @name なにか書く
    //! @{

    // ...
    
    //!@}

private:

    // ...
};