doxygen 俺的規約 - 涼の成長記録

今回開発するアプリケーションは、初めてのdoxygenに挑戦しようと思っています。以下のWEBサイトを参考に、私的に好みな感じにしてみました。できるだけ、書く量が少なくなるように意識しています。いるかなー。。？と思ったらいらない。初めてなので、まだコロコロと変わると思いますが、当面はこれでいきます。
Doxygen

ファイルの先頭

/*!
    @file   xxxx.h
    @brief  XXXXクラスの宣言
    
            何か注意事項等の特記があれば、ここに書く。@noteでも良いけど。
            クラスの振る舞いは、クラス宣言の先頭に書くので、ここでは書かない。
            バージョンや、開発プロジェクトの名前等は、モジュールの再利用性を高めるため書かない。
            知りたければ、社内データベースから引っ張ってくれば良いのだ。

    @author 私の名前を誇らしげに書く。

    @date   [Sep. 2013] 日まで書くと、面倒くさいので月まで。変更履歴を書く。新規なら@dateは書かない。
*/

クラス宣言の先頭

/*!
    XXXXクラス

    クラスの概要を説明する。
*/

メソッド宣言の先頭

つまり、ヘッダーファイルに書きます。C++Builderの場合に、イベントハンドラーをどうするか悩みますが、ヘッダーファイルに書きたいです。

/*!
    メソッドの概要。@briefが冗長なので、QT_AUTOBRIEFをYESにしておく。

    メソッドの詳細を、必要があれば説明する。

    @param  arg1  :その引数の概要
    @param  arg2  :[in][out]とかは、ここのコメントでカバーできると思うので、わざわざ書かない。

    @return 戻り値の内容を説明する。
*/

メンバー変数とか、構造体とか、定数とか、考えなければならないことは、まだまだありますが、これでガシガシ書いていこうと思います。
ではでは。