古いまたは誤ったコメントを削除する
Contents
Remove obsolete or incorrect comments. （古いまたは誤ったコメントを削除する）
解説
コードが変更されたにもかかわらずコメントが更新されないと、コメントが嘘の情報源となり、開発者を誤った方向に導きます。古いコメントは、コードの理解を助けるどころか混乱を招き、バグの原因となります。コードを変更する際は、関連するコメントも同時に更新するか、不要になったコメントは削除すべきです。正確なコメントのみが価値を持ちます。
具体例
// 悪い例（古いコメントが残っている）
type UserService struct {
db Database
}
// CreateUser creates a new user and sends a welcome email
// この関数はemailとpasswordを受け取ります
func (s *UserService) CreateUser(name string) error {
// 実際にはnameしか受け取っていない
// メール送信機能も削除済み
return s.db.Insert(name)
}
// ValidatePassword checks if password meets requirements
// パスワードは8文字以上必要です
func ValidatePassword(password string) bool {
// 実際には12文字以上に変更された
return len(password) >= 12
}
// 良い例（正確なコメント）
type UserService struct {
db Database
}
// CreateUser creates a new user with the given name
func (s *UserService) CreateUser(name string) error {
return s.db.Insert(name)
}
// ValidatePassword checks if password is at least 12 characters
func ValidatePassword(password string) bool {
return len(password) >= 12
}
参考リンク
古いまたは誤ったコメントを削除する https://www.tricrow.com/core/coding-standard/remove-obsolete-comments.html
