GoogleのJavaのスタイルガイドでは、フィールド名は lowerCamelCase で書き、名詞か名詞句にするのが一般的とされています(Google Java Style Guide)。言語やチームによって書き方(camelCase、snake_case)は違いますが、「中身を表す英語の名詞」という考え方は共通です。
日本語から引ける変数名の英語一覧
| 日本語 | 英語 | 変数名の例 |
|---|---|---|
| 閾値 | threshold | maxRetryThreshold |
| 判定(〜かどうか) | is / has / can + 形容詞・名詞 | isValid, hasPermission |
| 件数 | count | userCount |
| 合計 | total / sum | totalPrice |
| 平均 | average / avg | averageScore |
| 一覧 | list / 複数形 | users, itemList |
| 最大・最小 | max / min | maxLength, minAge |
| 現在の | current | currentPage |
| 前回の | previous / last | previousValue, lastLoginAt |
| 次の | next | nextToken |
| 一時的な | temp / temporary | tempFile |
| 結果 | result | searchResult |
| 状態 | status / state | orderStatus |
| 種類 | type / kind | fileType |
| 設定 | config / settings | appConfig |
| 引数 | args / params | requestParams |
| 開始・終了 | start / end | startDate, endDate |
| 期限 | deadline / expiresAt | expiresAt |
| 作成日時 | createdAt | createdAt |
| 更新日時 | updatedAt | updatedAt |
| 有効・無効 | enabled / disabled | isEnabled |
| 削除済み | deleted | isDeleted, deletedAt |
| 表示する | visible / shown | isVisible |
| 選択中の | selected | selectedItem |
| 入力 | input | userInput |
| 元の | original | originalName |
| 対象 | target | targetUser |
| 残り | remaining | remainingDays |
| 回数(試行) | attempts / retries | retryCount |
| 失敗 | failure / error | failureReason |
| 一意の識別子 | id | orderId |
| フラグ | flag(中身を表す名前が望ましい) | isPaid(flag1 は避ける) |
命名の5つのコツ
- 真偽値は質問の形に。
isEnabled、hasChildren、canEdit、shouldRetry。読むと「〜か?」に答える名前にします。 - コレクションは複数形。
userは1人、usersは複数。userListよりusersが簡潔です。 - 単位を名前に入れる。
timeoutSeconds、sizeInBytes。数字だけでは秒かミリ秒か分かりません。 - 略語は広く通じるものだけ。
id、url、maxは可。自作の略語(usrNm)は避けます。 - ローマ字は避ける。
kingakuはチームに日本語話者がいないと読めません。英語が分からないときは、訳語を辞書や翻訳で確かめてから使います。
なぜ変数名は英語なのか
プログラミング言語のキーワードや標準ライブラリ、ドキュメントの多くが英語で書かれているため、変数名も英語にするとコード全体が一続きの文のように読めます。海外のメンバーやOSSのコントリビューターも読めるようになり、検索もしやすくなります。日本語の変数名が使える言語もありますが、チームで共有するコードでは英語が一般的です。
関数・メソッドの名前は動詞で始めます。詳しくは関数名の英語:命名に使う動詞一覧へ。
Devlingoで開発現場の英語を1日10フレーズ
Gambit StudioのDevlingo(English for Devs)は、開発者のための英語フレーズアプリです。デイリースタンドアップ、コードレビュー、Slack、プルリクエスト、バグ報告、面接など12カテゴリに3,600以上のフレーズを収録し、1日10個ずつ、使う場面と発音ガイド、例文つきで学べます。ホーム画面ウィジェットには今日のフレーズが表示されます。画面表示は英語などで、日本語には対応していません。