Gecko_Newt Gecko_Newt 2014-11-30 21:10:59

[Java] もうコメント書くなお前 このエントリーをはてなブックマークに追加

投稿者からのアピールポイント

改修案件でぶち当たったソース マジでこんなのに遭遇することってあったんだなぁ・・・ 他にもろくに追記されていないjavadocがゾロゾロ・・・ 頼むから、javadoc書くなら最後まで責任持ってくれよ・・・

/**
  *
  *   〇〇の値を取得する
  *
  */
public void getFoo(int foo){
    this.foo = foo;
}

使い方ヒント: 「これは臭う」という行を見付けたら、各行のsmellをクリックしてマーキングしておきましょう(要Twitter OAuth認証)

コメント(5)

#1 kuma056 kuma056 2014-12-10 22:11:32  

これって、Setterですよね?

#2 yoshida_kimko yoshida_kimko 2015-01-05 14:48:23  

規約でjavadocをしっかり書くように定めてないならまあこれくらいなら別に、、って思う。

それよりもgetterな名前なのにsetterになってる方がはるかにトラップではw

#3 c_9_l c_9_l 2015-01-06 22:23:32  

getterな名前なのに引数で首を傾げて、戻りがvoidであることで名前間違いだと推測し、しかしコメントはgetterな文面だから誰かがコメントしたはずなのにとさらに首を傾げて…

#4 InternalServerE InternalServerE 2015-03-21 05:11:42  

他の方からも指摘出てますが、setterにgetな名称を与えてる方が遥かに巨大で、投稿の主旨のjavadoc云々が霞んで見える。

現場でいちいちjavadocの品質にメクジラ立ててたら仕事にならない、という愚痴も脳裏をかすめましたが
投稿の主旨とはちょっとずれますかね。。

syntaxどうこう以前に、そもそも説明になってないんだよ、そのニホンゴ、みたいな。

#5 kuma056 kuma056 2015-03-27 00:07:06  

呼び出し側が、インスタンスの○○の値を取得する。

ではなく

インスタンスが、外部の○○の値を取得する。

と解釈すると、意味は通じる。 通じるんだが...

コメント投稿には、twitter認証が必要です。

Twitter認証

このウンコードに臭った人は、こちらのウンコードにも臭ってます

[Java] is禁止令

このエントリーをはてなブックマークに追加

ウンコードの趣旨とは違い、レビューで指摘...

// Mod yamada Start

// 一般的に考えて真偽値を返すメ...

鑑賞する »

[Java] 連番

このエントリーをはてなブックマークに追加

もはや人間が読むものではない。

...

package com.renban.erq053.czp008;

/**...

鑑賞する »

[C] ×有限ループ ◯無限ループ

このエントリーをはてなブックマークに追加

有限ループのはずが、無限ループに... ...

int i,j;
for(i=0;i<100;i++) {
 for(j=0...

鑑賞する »