【メモ】不要なコメントがおりました

エラーを握りつぶしている所を発見。
理由を知りたかったけど有識者に聞くしかなかったのでメモしておく。
(ついでに近辺で気になったコメントのこともメモ)

無意味なコメント

〇〇をする。 や 〇〇である。 みたいなコメントは、コードを見ればわかります。
コメントは　What ではなく Why/Why not を書く様にしてください。

Bad

try {
    // ...何らかの処理
} catch(Exception e) {
    // 何もしない
}

Better

try {
    // ...何らかの処理
} catch(Exception e) {
    // ○○なのでエラーにさせない
}

説明のためのコメント

複雑なものはコメントで説明するのではなく、名称(変数や関数など)でわかる様にしてください。(そもそも複雑怪奇な処理は避けてください)
単純なものは見ればわかるので不要です。
コメントは負債であると考えてください。
コードを修正する時に合わせて修正(の判断)をしなければならないものです。
修正が漏れて、不適切な内容となってしまった場合、他のコメントの信用も低下してしまいます。

Bad

if (hoge === null && hoge === "") {
    // 空の場合
} else if (/* 条件いっぱい */) {
    // 〇〇の時
}

// 結果を返す
return result;

Better

/* ex) 関数化しておく */

private function isEmpty(value) {
    return value === null || value === "";
}

private function isHoge() {
    // ...何らかの判定処理
}

if (this.isEmpty(hoge)) {
    // ...何らかの処理
} else if (this.isHoge()) {
    // ...何らかの処理
}

return result;