涼の成長記録

自らの人生に主導権を持つべく、独立を目指して2014年3月31日を持ってITエンジニアを退職。そんな23歳♂の成長記録。

アクセサメソッドにdoxygenコメント入れると冗長

まあ、記事タイトルの通りなのですが、

/*!
    高さを返す。

    @return 高さ
*/
int getHeight();

/*!
    横幅を返す。

    @return 横幅
*/
int getWidth();


のような感じで、ずらーっと冗長なメソッド宣言が並ぶことになります。@returnを与えないと、ドキュメント化されてくれないのは、対策できないのでしょうか。これぐらいにしたいのですがね。

//! 高さを返す。
int getHeight();

//! 横幅を返す。
int getWidth();


まあ、この程度のアクセサメソッドをドキュメント化する必要があるかと言われると、多分ないと思うのですが、他のメソッドとコメントの付け方に、一貫性がなくなってしまうと、それはそれで気持ち悪いです。大量のアクセサメソッドを準備しなければならない、クラス設計そのものが悪いのでしょうか。


ではでは。