前置き
チーム開発や、（好ましくないものの）人がよく入れ替わるプロジェクトなどにおいてドキュメントのメンテナンス具合や検索のしやすさは新規参画者のオンボーディングをスムーズにする上でとても重要です。
我々エンジニアについては、もちろんコーディングをするのでソースコードの読みやすさも同等に重要です。
よく、綺麗なコーディングという意味で以下のような書籍があります。
良いコード／悪いコードで学ぶ設計入門―保守しやすい 成長し続けるコードの書き方
リーダブルコード
Good Code, Bad Code ～持続可能な開発のためのソフトウェアエンジニア的思考
「良いコード」に関する議論をすると沼にハマっていきそうですが、やはり「命名の適切さ」は欠かせません。
また、昔のように「変数は極力短い方がいい」という思想は薄れており、近年は「多少長くてもいいからわかりやすいもの」が推奨されています。
基本的な命名の注意点
命名をする際に、基本的には以下のことに気をつけるようにと書籍やブログで散見されます。
（他にも色々な角度からの意見はあるのであくまで一例）
- 抽象度の高い命名は避ける（fetchItemInfoとかは何の？としか思えない）
- 処理内容の要約のようになるようなラベル付をする
- 逆にラベル以上のことをしないように実装は気を配る
- 二重否定をしない（isNotDisabledはisEnabledと言い換えられる）
また、以下の記事も定番のメソッド名についての解説があります
一部抜粋
※ 全概要は上記記事を閲覧してください
| 動詞名 | 日本語表現 | 主な戻り値 |
|---|---|---|
| Get | 取得する | オブジェクト |
| Set | 設定する | void |
| Update | 更新する | void (updateした件数返す場合も) |
| Delete | 削除する | void (deleteした件数返す場合も) |
| Insert | 挿入する | void |
| Select | 選択する | オブジェクト |
| Find | 選択する | オブジェクト |
| Add | 追加する | void |
| Remove | 削除する | オブジェクト |
| Clear | クリアする | void |
困った時にはツールに頼ってみる
もちろん、自分の知識をつけていくことがとても大切なのですが、AIやツールの頼むのも良いと思います。
有名どころでいうと、ChatGPT, Codicなどがあります。
いくつかの日本語をそれぞれcodicとChatGPTに渡してみた回答を見てみましょう。
なお、ChatGPTはモデル「GPT-4」とします。
前提として、codicは1つの結果しか返しませんが各項目で別の候補があれば以下のように提示してくれます。
例題
1. 顧客一覧に含まれる
codic: contain_to_customer_list
ChatGPT4: isCustomerInList, checkCustomerExists, findCustomerInDatabase, customerLookup
2. メールを送信済みのユーザーか
codic: email_sent_user_is
ChatGPT4: hasSentEmail, isEmailSent, checkEmailStatus, userEmailConfirmation
3. 履歴に登録済みかどうか
codic: history_registered
ChatGPT4: isRegisteredInHistory, isInHistory, hasHistoryEntry, checkHistoryStatus
いかがでしょうか？
以前codicは推奨されていましたが、ChatGPTの方が比較的良い候補を出してくれる印象がありますね。
GeminiやClaudeのように他のAIチャットのツールもあると思いますが、困った場合は活用してみてください。