inabajunmr inabajunmr 2015-05-28 21:22:40

[Java] わかりやすいコメント このエントリーをはてなブックマークに追加

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

とてもわかりやすい

//インスタンスを作る
List<String> list = new ArrayList<String>();

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

コメント(3)

#1 InternalServerE InternalServerE 2017-04-09 05:03:36  

  • 複数行にわたる処理の流れをわりと丁寧にコメントしたい場合(複雑な処理を書くケースや、設計書と実装の対応が追いづらいような処理を書くケースが主に該当)
  • 視覚的に見落とさないようなメッセージングを行いたい場合(インスタンス生成であれば、オブジェクトの生成・消滅のライフサイクルを明示したい場合ですね)

こういうケースだと、単純な内容でもあえてコメントに残すことは普通にあったりします。
「アピールポイント」のコードだけ単独で見て、ウンコかどうかって判断できますかねえ。

#2 deigotter deigotter 2017-06-10 20:30:49  

普通は「@@@を格納するリスト」とか書くんだよ だからウンコ

#3 InternalServerE InternalServerE 2017-06-25 06:51:03  

変数に「用途」を書きたいのであればdeigotterさんの指摘であってるだろうね。

一方、処理構造を補足したいのであれば、また違う書き方になるし、
「なんでこんなコードになっているのか」という制約、顧客要件といった
「背景」に関する補足であれば、また全然違う書き方になる。

要は、コメントに何を書くかって、何を補足したいかの「目的」次第だよ。
コードに対して一意に決まる、というものではない。

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

Twitter認証

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

[Java] 連番

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

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

...

package com.renban.erq053.czp008;

/**...

鑑賞する »

[Java] nullチェック

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

SVNの更新内容を眺めてたら、凄いコード...

// nullチェック
if(list.isEmpty(){
    // ...

鑑賞する »

[Java] is禁止令

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

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

// Mod yamada Start

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

鑑賞する »