[Java] もうコメント書くなお前-ウンコード・マニア

Gecko_Newt 2014-11-30 12:10:59

[Java] もうコメント書くなお前

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

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

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

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

これって、Setterですよね?

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

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

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

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

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

#4 InternalServerE 2015-03-20 20:11:42

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

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

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

#5 kuma056 2015-03-26 15:07:06

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

ではなく

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

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

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

Twitter認証

« Java一覧に戻る

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

// Mod yamada Start

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

頭の中で何を考えてCSSを書いているのだ...

.hoge{
  color : #030303 ;
  border : ...

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

...

package com.renban.erq053.czp008;

/**...