関数名は動詞または動詞+目的語で命名する
Contents
Name functions with a verb or verb + object. （関数名は動詞または動詞+目的語で命名する）
解説
関数は動作を表すため、動詞で始まる名前が自然で理解しやすくなります。動詞+目的語の形式は、関数が何を行うかを明確に伝え、コードの可読性を向上させます。名詞だけの関数名は、その関数が何をするのか不明確であり、混乱を招きます。一貫した命名規則に従うことで、チーム全体でのコードの理解が容易になります。
具体例
// 悪い例（名詞のみ、または不明瞭）
func User(id string) User {
// Userは名詞のみで、何をする関数か不明
}
func Data() []byte {
// 何のデータを取得するのか不明
}
func Process() {
// 何を処理するのか不明
}
func Order(items []Item) {
// 注文を作成？取得？
}
// 良い例（動詞+目的語）
func GetUser(id string) User {
// ユーザーを取得することが明確
}
func FetchUserData() []byte {
// ユーザーデータを取得することが明確
}
func ProcessOrder(order Order) error {
// 注文を処理することが明確
}
func CreateOrder(items []Item) (Order, error) {
// 注文を作成することが明確
}
func ValidateEmail(email string) bool {
// メールアドレスを検証することが明確
}
func CalculateTotalPrice(items []Item) float64 {
// 合計金額を計算することが明確
}
func SendNotification(user User, message string) error {
// 通知を送信することが明確
}
func UpdateUserProfile(userID string, profile Profile) error {
// ユーザープロフィールを更新することが明確
}
func DeleteExpiredSessions() error {
// 期限切れセッションを削除することが明確
}
参考リンク
関数名は動詞または動詞+目的語で命名する https://www.tricrow.com/core/coding-standard/verb-function-names.html
