Web Programming
この記事では「Web Programming」について、基本の意味と使い方を初心者向けにやさしく説明します。
Having clear rules for names makes your code easy to understand.
命名規則
このページでわかること
- 変数・関数・ファイルに意味のある名前を付ける方法
- camelCaseなどの代表的な書き方
- 規則の種類より、プロジェクト内で一貫させる重要性
プログラムやWeb制作では、変数や関数、ファイル名などにわかりやすい名前をつけることが大切です。これを「命名規則」と呼びます。
命名規則を守ると、コードを読んだときに「この名前は何を意味しているのか」がすぐに理解でき、あとで自分や他の人が修正するときも迷いにくくなります。
たとえば、「ユーザーの名前」を扱うなら userName のように書く、といったルールを最初に決めておき、全体で統一するのがポイントです。
命名規則の種類
命名規則には多くの種類があり、どれを使うかでコードの見やすさや一貫性が変わってきます。
- キャメルケース (camelCase)
- 単語の区切りを大文字で表す方法。最初の単語は小文字で始める。JavaScriptの変数や関数名によく使われる。
- 例:
userName,getUserData,totalPrice - パスカルケース (PascalCase)
- 各単語の先頭を大文字にする方法。クラス名やコンストラクタ関数でよく使われる。
- 例:
UserName,GetUserData,TotalPrice - スネークケース (snake_case)
- 単語の区切りをアンダースコア「_」でつなぐ方法。Pythonの変数名や関数名でよく使われる。
- 例:
user_name,get_user_data,total_price - アッパースネークケース (UPPER_SNAKE_CASE)
- スネークケースをすべて大文字で書く方法。定数名に使われることが多い。
- 例:
MAX_VALUE,DEFAULT_TIMEOUT,API_KEY - ケバブケース (kebab-case)
- 単語の区切りをハイフン「-」でつなぐ方法。HTMLの属性名やCSSのプロパティ名でよく使われる。
- 例:
background-color,data-user-id,font-size - ハンガリアン記法 (Hungarian Notation)
- 名前の先頭にデータ型や用途を表す接頭辞をつける方法。古いC言語やWindows APIで使われていた。
- 例:
strUserName,iCount,btnSubmit - フラットケース (flatcase)
- すべて小文字で、区切り記号を使わない書き方。URLの一部や一部のファイル名で利用されることがある。
- 例:
username,getuserdata,totalprice - トレインケース (Train-Case)
- 各単語をハイフンで区切り、先頭を大文字にする方法。あまり一般的ではないが、文書構造を強調したいときに使われる。
- 例:
User-Name,Get-User-Data,Total-Price - ドットケース (dot.case)
- 単語の区切りにドット「.」を使う方法。設定ファイルや一部のデータ表現で使われる。
- 例:
user.name,get.user.data,total.price - スラッシュケース (slash/case)
- 単語をスラッシュ「/」で区切る方法。ディレクトリ構造やルーティングで使われる。
- 例:
user/name,api/get/user,product/total/price
上記は代表的な例ですが、実務でよく使われるのは camelCase / PascalCase / snake_case / UPPER_SNAKE_CASE / kebab-case あたりです。