変数と関数には意味のある名前を使う
Contents
Use meaningful names for variables and functions (e.g., good: getUser() / bad: method1()).
（変数と関数には意味のある名前を使う（例: 良い getUser() / 悪い method1()））
解説
変数や関数に意味のある名前を付けることは、コードの可読性と保守性を高める基本原則です。名前から目的や役割が明確に伝わることで、他の開発者がコードを理解しやすくなります。抽象的な名前や番号付きの名前は、コードレビューやデバッグ時に混乱を招き、バグの温床となります。MUST項目として、すべての変数と関数に対して例外なく適用されるべきルールです。
具体例
// 悪い例
func method1() User {
var a = "john@example.com"
var b = fetchData(a)
return b
}
// 良い例
func getUser() User {
userEmail := "john@example.com"
user := fetchUserByEmail(userEmail)
return user
}
参考リンク
変数と関数には意味のある名前を使う https://www.tricrow.com/core/coding-standard/meaningful-names.html
