コードを単に言い換えるだけのコメントを書かない
Contents
Do not write comments that merely restate the code (e.g., int a // declare integer a).
（コードを単に言い換えるだけのコメントを書かない（例：int a // 整数aを宣言））
解説
コードをそのまま言い換えただけのコメントは、情報を追加せず、コードのノイズとなります。コメントは、コードから読み取れない意図や理由、背景を説明するべきです。自明な内容をコメントで繰り返すことは時間の無駄であり、コメントのメンテナンスコストを不必要に増加させます。意味のあるコメントのみを書くことで、コードの可読性が向上します。
具体例
// 悪い例（自明な内容の繰り返し）
// increment i by 1
i++
// create a new user
user := User{}
// check if name is empty
if name == "" {
return errors.New("name is required")
}
// loop through all items
for _, item := range items {
// process item
process(item)
}
// 良い例（意図や理由を説明）
// ユーザーIDは1から開始（0は予約済み）
i := 1
// デフォルト値で初期化（後でAPIレスポンスで上書き）
user := User{Status: "pending"}
// 空の名前は無効（ビジネスルール）
if name == "" {
return errors.New("name is required")
}
// すべてのアイテムに対して在庫を減算
// エラーが発生してもロールバックしない（べき等性保証）
for _, item := range items {
process(item)
}
// コメント不要な例（コード自体が明確）
func calculateTax(price float64) float64 {
return price * 0.1
}
if user.IsActive() {
sendNotification(user)
}
参考リンク
コードを単に言い換えるだけのコメントを書かない https://www.tricrow.com/core/coding-standard/no-obvious-comments.html
