おこさま用コメント

コードとコメントが１対１のプログラムに出会った。
そういえば、意味のないコメントってよく見るなぁ。

if(goodsId == null) {
    // パラメータがNULLの場合
    return null;
}

みればわかる。

// 数量の取得
String number = ParameterDTO.getNumber();

みればわかる。

// 名前
String name = null;
// 価格
BigDecimal price = null;
// 数量
BigDecimal number = null;

みればわかる。

// リストが6件であることを確認
assertEquals("", 6 ,list.size());

あほか。

クラス名、変数名、メソッド名にはわかりやすい名前を付けること。利用側から名称だけで、意味や動作が理解できるようにすること。コメントだらけのコードは読みにくくてしかたがない。

他人のソースコードにはなるべく目を通すこと。