javadocでメンバを示す書き方

質問

javadocコメントの書き方で質問です。

あるメソッドの返値が、端的にそのクラスのメンバであることを示す場合の書き方があったりするのでしょうか？
下記の例でいうと、「@return バナナの値段」のところですが、メンバのbananaに絡めて書くことはできないでしょうか？

/**
* 値段
* @author aaaa
* @version 0.1
*/
class nedan{
/** バナナの値段 */
private int banana = 50;

/**
* バナナの値段を返すメソッド
* @return バナナの値段
*/
public int get_banana(){
return this.banana;
}
}

回答No.1

ChateauAres · ベストアンサー

JavaBeansのプロパティの命名規則に従ってコーディングすれば、それがメンバであることが一目瞭然なのでjavadocのコメントで対応する必要を感じません。

public int getBanana()
と書いてあれば、それはメンバー変数bananaを取得するメソッドだよって分かります。

メソッドの命名規則は、もちろん各社各人自由ですが、上記ルールで実施している所は多いと思いますよ。

お礼

ありがとうございました。
JavaBeansは恥ずかしながら初めてしりました。
命名規則もネットにあったので、これに従って書こうと思います。
http://www.asahi-net.or.jp/~dp8t-asm/java/tips/JavaBeansSignature.html