shikumika’s diary

日々の事務作業で手間なことを簡単にできる仕組み(自動化、方法など)、困ったことの解決方法を調べた備忘録

【JavaScript】AIが書いたコードを読み解くために知っておきたい!命名規則の基本ルール

「AIに書いてもらったコードの内容を理解して使いたい」「コードを貼り付けたけど、どこを直せばいいかわからない」と困っていませんか?

JavaScriptの命名規則(名前の付け方のルール)を少し知ると、コードの内容が理解しやすくなります。「書き換えポイント」も見つけやすくなります。今回はその基本の備忘録です。

内容:

命名規則を知るとコードが読みやすくなる

AIが書いたコードの変数名や関数名の多くは、一般的な命名規則にもとづいて作成されています。その規則を知ると、「この変数にはどんな値が入っているのか」が想定でき、コードが理解しやすくなります。

「あ、ここは設定値だな」「ここは計算結果だな」と、一目で役割を把握できます。

まずは覚えておきたい3つの形式

① キャメルケース(camelCase)

変数名や関数名に使います。最初の単語は小文字、2つ目以降の単語の頭文字だけ大文字にします。

zipValuerecordDatacalculateTotal など

JavaScriptで最も標準的な書き方です。AIが生成するコードの変数名の多くはこの形式です。

② アッパースネークケース(UPPER_SNAKE_CASE)

定数(設定値など、途中で変えないもの)に使います。すべて大文字にして、単語の間を _ でつなぎます。

ZIP_FIELDERROR_MSGAPI_KEY など

AIが上手にコードを作ると、コードの冒頭に定数をまとめた「設定エリア」が登場します。書き換えるべき場所は大抵この形式で書かれているので、見つけやすくなります。

③ パスカルケース(PascalCase)

クラス名などに使います。すべての単語の頭文字を大文字にします。

UserManagerFormValidator など

初心者のうちは「大きな部品の名前」と覚えておけば十分です。

接頭辞・接尾辞でコードの役割を読み取る

名前の先頭(接頭辞)や末尾(接尾辞)に特定の言葉を添えることで、その変数や関数が「何者なのか」をより明確にする手法もよく使われます。

種類 よく使われる言葉 役割と具体例
真偽値(Yes/No) ishascan 状態や権限を表す。isVisible(表示中か)、hasError(エラーがあるか)
動作(関数) getsetonhandle 何をするかを表す。getRecord(取得)、handleClick(クリック処理)
データの集まり s(複数形)、ListArray 複数のデータが入っていることを表す。usersrecordList

たとえば、AIが出したコードの中に if (hasError) という一文があれば、「ここでエラーの有無をチェックしているんだな」と直感的に読み取れます。

変数名と実際の値は一致させる

変数名と、それが指す実際の値は一致させるのがベストプラクティスです。郵便番号を扱うなら、変数名も zipCodepostalCode にします。こうしておくと、コメントなしで「この変数が何を指しているか」を読み取れます。

また、大文字と小文字は厳密に区別されますzipCodeZipCode はJavaScriptでは別物として扱われるため注意しましょう。

まとめ

  • キャメルケースは変数や関数名の基本。AIが書くコードのほとんどはこの形式。
  • アッパースネークケースは「書き換えポイント」の目印。コード冒頭の定数エリアを探せばよい。
  • 接頭辞(isget など)を意識すると、コードの役割(Yes/Noなのか、動作なのか)が一目でわかる。
  • 変数名と実際の値は一致させると、コードが格段に読みやすくなる。

以上、AIが書いたコードを読み解くために知っておきたい!命名規則の基本ルールでした。