スクリーミングスネークケース
スクリーミングスネークケース(英: screaming snake case)とは、ソフトウェア開発における命名規則の一つであり[1][2][3][4][5]、アルファベットの大文字とアンダースコア_
を使用して単語を区切る形式である(例:SCREAMING_SNAKE_CASE
)[6][7][8][9][10]。この命名規則は、特に定数や設定値の定義において用いられることが多く、その明瞭性と一貫性が特徴である。
ただし「スクリーミングスネークケース」は俗称に近い[要出典]ものであり、公式なドキュメントやスタイルガイドではあまり用いられず、個々のプログラミング言語において、それぞれ独自に同じ形式を指す表現として「アッパーケーススネークケース(英: uppercase snake case)[10][11][12]」「コンスタントネーミングコンベンション(英: constant naming convention)[13]」「コンスタントケース(英: constant case)[14][15]」などが用いられる。他にも呼称は存在するが、出典として有用なものが存在しないため、ここでは省略する。これらの表現はそれぞれのプログラミング言語のスタイルガイドに属するものであり、一般的には全ての言語において横断的に理解されるというものではない[注釈 1]。横断的に理解される、よりフォーマルな呼称として「アッパースネークケース(英: upper snake case)[16]」が存在するが、これもプログラミングにおける命名規則の形式に対する名前として国際的に標準化されているわけではない[17][18]。「スクリーミングスネークケース」は俗称に近いとはいえ、プログラミングのコミュニティでは広く親しまれている呼称であり、現代のプログラミング文化やコミュニティ[19][20][21][22]においてその呼称と形式は一定の影響力を持っており、しばしば命名規則に関する議論の中で言及される。
スクリーミングスネークケースの起源は明確ではない。初期の使用例は、C言語やその派生言語に見られる[23][24]。これらのプログラミング言語においては、定数やマクロの名前を区別するために、スクリーミングスネークケースが頻繁に用いられてきた。
他の命名規則(パスカルケース、キャメルケース、ケバブケースなど)との比較においても、スクリーミングスネークケースは独自の位置付けをもつ。例えば、PythonのPEP8スタイルガイド[10]では、モジュールレベルの定数にスクリーミングスネークケースを推奨している。
実際の使用状況としては、PythonやJava、JavaScriptなどの主要なプログラミング言語や、各種フレームワーク、ライブラリにおいて見られる[10][6][7]。このように標準化された命名規則は、特に大規模なコードベースや複数人での開発環境において、その効果が顕著である[25][26]。標準化された命名規則は、可読性の向上や命名の一貫性を目的としており、特にコードレビューや共同開発の場面でその利点が発揮される[25][26]。
本ページでは、スクリーミングスネークケースの定義から始まり、その歴史、利点と欠点、適用範囲や適用例について各種ガイドラインと共に詳述する。
定義
スクリーミングスネークケースは、プログラミングにおける命名規則の一つであり、識別子を大文字のアルファベットとアンダースコア_
で構成する形式である[1][2][3][4][10][6][7][8][5][9]。この規則では、各単語がアンダースコア_
で区切られ、全ての文字が大文字で表記される。例えば、「MAX_VALUE
」や「USER_NAME
」のように表記される。
「スクリーミング」の由来は、コミュニティによれば、全て大文字で表記されることで「叫んでいる(英: screaming)」ように見えることだという[注釈 2]。
スクリーミングスネークケースは、特に定数や不変の値を定義する際に使用されることが多い。この命名規則を用いることで、コードの可読性が向上し、識別子が他の変数や関数と明確に区別される。さらに、アンダースコア_
によって単語が視覚的に区切られるため、長い識別子でも読みやすくなるという利点がある。
一般に、スクリーミングスネークケースは以下のようなルールに従う。
- 全ての文字は大文字である。
- 各単語はアンダースコア
_
で区切る。 - 数字はそのまま使用する。
この命名規則は、多くのプログラミング言語やフレームワークで採用されており、特に定数の宣言や設定値の定義において推奨されることが多い。例えば、PythonのPEP8スタイルガイド[10]では、モジュールレベルの定数に対してスクリーミングスネークケースを使用することが推奨されている。また、Java[6]やJavaScript[7]のスタイルガイドでも、定数の命名にこの形式を採用することが一般的である。
スクリーミングスネークケースのように標準化された命名規則は、その明瞭性と一貫性から、特に大規模なプロジェクトやチーム開発において有用である[25][26]。識別子が明確に区別されるため、コードの保守性が向上し、バグの発見や修正が容易になる。以上の特性から、スクリーミングスネークケースは、プログラミングにおける重要な命名規則の一つとして広く認識されている。
歴史
以下にスクリーミングスネークケースの歴史を示すが、ここで示すのは「スクリーミングスネークケースの形式」についての歴史であり、「スクリーミングスネークケース」という呼称が用いられ始めた時期については情報がない。
1980年代:黎明期
スクリーミングスネークケースの起源は明確には定義されていないが、その使用はコンピュータプログラミングの黎明期に遡ることができる。この命名規則は、特にC言語やその派生言語において初期から用いられてきた[23][24]。C言語では、定数やマクロの名前を視覚的に区別するためにスクリーミングスネークケースが採用され、その後、多くのプログラミング言語に広がっていった。
1990年代:普及期
1980年代から1990年代にかけて、プログラミングが普及し、コードの可読性や保守性が重要視されるようになると、命名規則の一環としてスクリーミングスネークケースの利用が増加した。特に、Unix系システムやオープンソースプロジェクトにおいて、一部の定数やマクロ名にこの命名規則が使用されることがあった[27][28][29]。
2000年代:標準化
PythonのPEP8スタイルガイド[10]が2001年に公開された際、モジュールレベルの定数に対してスクリーミングスネークケースを使用することが推奨された。これにより、Pythonコミュニティ内での普及が進み、他のプログラミング言語やフレームワークでも広く採用されるようになった[30][31][11][12]。
2010年代以降:拡大と深化
Java[6]やJavaScript[7]などの言語においても、コードの可読性を高めるためにスクリーミングスネークケースが使用されるようになった。これらの言語のスタイルガイドやベストプラクティスにおいても、定数の命名規則としてスクリーミングスネークケースが推奨されている。
現代以降:大規模プロジェクトとチーム開発
現代では、大規模なソフトウェア開発プロジェクトやチーム開発において、スクリーミングスネークケースは識別子の一貫性と明瞭性を確保するための重要な命名規則の一つとなっている[26][32]。例えば、オープンソースプロジェクトや企業の内部プロジェクトにおいて、定数や設定値の命名にスクリーミングスネークケースが用いられることが一般的である。
このように、スクリーミングスネークケースは、プログラミングの歴史を通じて、その有用性と利便性から広く採用されてきた命名規則である。
利点
スクリーミングスネークケースは、特に定数や設定値の命名において広く採用されている命名規則であり、以下のような利点がある。
可読性の向上
スクリーミングスネークケースは、全ての単語を大文字で表記し、アンダースコア_
で区切ることによって識別子の可読性を向上させる。これにより、プログラマーは定数や設定値を他の変数や関数と直感的に区別できるようになる。例えば、「MAX_VALUE
」や「CONFIG_PATH
」のような識別子は、一目で定数であることが認識されやすい[33][34]。
命名の一貫性
スクリーミングスネークケースを含む標準的な命名規則を使用することで、コードベース全体で命名規則の一貫性が保たれる。これにより、複数の開発者が関わる大規模なプロジェクトや長期的なメンテナンスが必要なコードにおいて、コーディングスタイルの統一が図られ、コードの理解や保守が容易になる[26][32]。
バグの防止
識別子が一目で定数であることを示すため、誤って値を変更するリスクが減少する。また、アンダースコア_
によって単語が明確に区切られるため、識別子の誤解読によるバグの発生を防止する効果もある[33][34]。
スタイルガイドとの整合性
多くのプログラミング言語やフレームワークのスタイルガイドでスクリーミングスネークケースが推奨されている。例えば、PythonのPEP8[10]やJavaScriptのAirbnb(民泊サービス)スタイルガイド[7]では、定数の命名にスクリーミングスネークケースを使用することが推奨されている。これに従うことで、他の開発者と共通の理解をもちやすくなる。
コードレビューの容易さ
スクリーミングスネークケースを使用することで、コードレビューの際に定数や設定値が直感的に識別できるため、レビューの効率が向上する[26][32]。レビュアーは、定数や設定値の命名が適切であるか、命名規則が一貫しているかを迅速に判断できる。
これらの利点により、スクリーミングスネークケースは多くのプログラミング言語やプロジェクトで採用されており、コードの可読性と保守性を高めるための重要な命名規則として広く認識されている。
欠点
スクリーミングスネークケースは、その利便性から多くのプログラミング環境で採用されているが、一方でいくつかの欠点も存在する。以下に、スクリーミングスネークケースの主な欠点を挙げる。
可読性の低下
全ての文字を大文字で表記するため、識別子が視覚的に煩雑になる場合がある。特に、長い識別子においては、アンダースコア_
で区切られているとはいえ、連続する大文字の羅列が一見して理解しにくくなることがある[26][35]。例えば、「THIS_IS_A_VERY_LONG_CONSTANT_NAME
」は、読みやすさの観点からは劣る。
一貫性の維持の難しさ
大規模なプロジェクトや長期に渡る開発において、全ての定数や設定値に対してスクリーミングスネークケースを一貫して適用するのは難しい場合がある[26][35]。特に、複数の開発者が関与するプロジェクトでは、命名規則の統一を維持するために継続的なレビューや教育が必要となる。
タイピングの負担
スクリーミングスネークケースでは、大文字とアンダースコア_
を頻繁に使用するため、タイピングが煩雑になる[26][35]。特に、頻繁に定数を入力する必要がある場合、タイピングミスが増加し、生産性に影響を与える可能性がある。
言語や環境による制約
一部のプログラミング言語や環境では、スクリーミングスネークケースを使用することが推奨されていない場合がある。例えば、Javaの命名規則では、クラス名やメソッド名にスクリーミングスネークケースを使用することは一般的ではない。このため、異なる命名規則を適用する必要がある場合、混乱が生じる可能性がある[34][36]。
これらの欠点にもかかわらず、スクリーミングスネークケースは特定の状況において有用であり、多くのプロジェクトで採用されている。開発者は、プロジェクトの特性やチームのスタイルに応じて、適切な命名規則を選択する必要がある。
適用範囲
スクリーミングスネークケースは、特定の状況や目的において有用であり、以下のような適用範囲が存在する。
定数の命名
スクリーミングスネークケースは、定数の命名において最も一般的に使用される[10][7]。この形式は、定数であることを明示的に示すため、コードの可読性と理解のしやすさを向上させる。例えば、物理定数や設定値、固定値などに用いられる。「MAX_VALUE
」や「PI_CONSTANT
」などがその典型である。
環境設定ファイル
環境設定ファイルにおける変数名にもスクリーミングスネークケースが用いられることが多い[37][38]。特に、環境変数や設定パラメータを識別するために使用される。例えば、.env
ファイルにおける「DATABASE_URL
」や「API_KEY
」などが該当する。
コンパイル時定義
コンパイル時に定義される値やマクロにもスクリーミングスネークケースが使用される[23][24]。C言語やC++では、#define
ディレクティブを用いたマクロ定義においてこの命名規則がよく見られる。例として、「BUFFER_SIZE
」や「MAX_THREADS
」などがある。
言語特有のスタイルガイド
多くのプログラミング言語やフレームワークのスタイルガイドで、特定の用途に対してスクリーミングスネークケースの使用が推奨されている。例えば、PythonのPEP8スタイルガイド[10]では、モジュールレベルの定数に対してスクリーミングスネークケースを使用することが推奨されている。また、JavaScriptのAirbnbスタイルガイド[7]でも定数の命名にこの形式が採用されている。
SQLクエリのフィールド名
SQLデータベースにおいて、フィールド名やテーブル名にスクリーミングスネークケースが使用されることがある[39][40]。これは、フィールド名やテーブル名が一目で識別しやすくなるためである。例えば、「USER_ID
」や「ORDER_DATE
」などがその例である。
プロジェクト固有の命名規則
大規模なプロジェクトやチーム開発において、命名規則の一環としてスクリーミングスネークケースが採用されることがある[26][35]。これにより、プロジェクト全体で一貫したコーディングスタイルを維持しやすくなり、コードの可読性と保守性が向上する。ただし、これには「欠点」項目で述べた通り、継続的なレビューや教育が必要となる。
スクリーミングスネークケースは、その明瞭性と一貫性から、特定の用途において非常に有用である。開発者は、プロジェクトやチームの要件に応じて、この命名規則を適用するかどうかを検討する必要がある。
適用例
スクリーミングスネークケースは、多くのプログラミング言語や環境で採用されており、様々な場面で使用されている。以下にいくつかの具体的な適用例を挙げる。
Python
Pythonでは、PEP8スタイルガイド[10]がモジュールレベルの定数に対してスクリーミングスネークケースを使用することを推奨している。
例えば以下のような定数定義がある。
MAX_CONNECTIONS = 100 # 最大接続数
DEFAULT_TIMEOUT = 60 # デフォルトのタイムアウト時間(秒)
JavaScript
JavaScriptのAirbnbスタイルガイド[7]でも、定数の命名にスクリーミングスネークケースを推奨している。
以下にその例を示す。
const MAX_RETRIES = 5; // 最大リトライ回数
const API_BASE_URL = "https://api.example.com"; // APIの基本URL
Java
Javaでは、クラスレベルの定数や静的な最終変数(英: Static Final Variables)にスクリーミングスネークケースが使用される[34][36]。
以下にその例を示す。
public class Constants {
public static final int MAX_USERS = 100; // 最大ユーザー数
public static final String BASE_URL = "https://example.com"; // 基本URL
}
C言語
C言語では、#define
ディレクティブを用いたマクロ定義や定数にスクリーミングスネークケースがよく使用される[23][24]。
以下にその例を示す。
#define BUFFER_SIZE 1024 // バッファサイズ
#define MAX_THREADS 8 // 最大スレッド数
環境変数
環境設定ファイル(例えば、.env
ファイル)やシェルスクリプトにおいても、スクリーミングスネークケースが広く使用されている[37][38]。
以下にその例を示す。
DATABASE_URL="postgres://user:password@localhost:5432/mydb" // データベースのURL
API_KEY="your-api-key" // APIキー
SQL
SQLデータベースにおけるフィールド名やテーブル名にもスクリーミングスネークケースが使用されることがある[39][40]。
以下にその例を示す。
CREATE TABLE USERS (
USER_ID INT PRIMARY KEY, -- ユーザーID
USER_NAME VARCHAR(100), -- ユーザー名
CREATED_AT TIMESTAMP -- 作成日時
);
JSON設定ファイル
JSON形式の設定ファイルにおいても、キー名にスクリーミングスネークケースが使用されることがある[37][41]。
以下にその例を示す。
{
"MAX_CONNECTIONS": 100, // 最大接続数
"DEFAULT_TIMEOUT": 60 // デフォルトのタイムアウト時間(秒)
}
これらの適用例は、スクリーミングスネークケースが様々なプログラミング環境で使用されていることを示している。この命名規則は、識別子の明確さと一貫性を保つための有効な手段として、多くの開発者に支持されている。
文化的影響
スクリーミングスネークケースはプログラミング文化やコミュニティに多大な影響を与えている。この命名規則は、その視覚的な特徴から、多くのミームやジョークの題材となってきた。以下に、スクリーミングスネークケースがもたらした文化的影響について詳述する。
プログラミングミーム
スクリーミングスネークケースは、その全ての文字が大文字であることから、インターネット上のプログラミングミームで頻繁に取り上げられる[26][32]。例えば、コードレビューの際に「なぜ定数が叫んでいるのか?」といったジョークが共有されることがある。このようなミームは、プログラマー間のコミュニケーションを和やかにし、プログラミング文化の一部として親しまれている。
教育と学習
スクリーミングスネークケースは、プログラミング教育の現場でも重要な役割を担っている[33][42]。初心者向けの教材やコースでは、命名規則の重要性を教える一環としてスクリーミングスネークケースが紹介されることが多い。これにより、初心者は早期に一貫した命名規則を習得し、よいコーディング習慣を身に付けることができる。
以上のように、スクリーミングスネークケースはプログラミング文化やコミュニティに対して多大な影響を与えてきた。その視覚的な特徴や標準化された命名規則としての役割を通じて、プログラマーのコミュニケーションを円滑にし、教育や学習においても重要な位置を占めている。このような文化的影響は、スクリーミングスネークケースが単なる技術的な命名規則以上の存在であることを示している。
命名規則一覧
名称 | 英語表記 | 説明 | 表記例 |
---|---|---|---|
スネークケース | snake case | 単語間をアンダースコア(_ )で繋ぐ形式。
|
example_variable
|
スクリーミングスネークケース | screaming snake case | 単語間をアンダースコア(_ )で繋ぎ、全て大文字にする形式。「アッパースネークケース(upper snake case)」や「コンスタントケース(constant case)」とも呼ばれる[16]。
|
EXAMPLE_VARIABLE
|
キャメルケース | camel case | 各単語の頭文字を大文字にし、単語を連結する形式(最初の単語のみ頭文字が小文字)。.NETの文脈で使用。 | exampleVariable
|
ローワーキャメルケース | lower camel case | キャメルケースと同じ形式だが、フレームワークや言語に依存しない表現。 | exampleVariable
|
パスカルケース | Pascal case | 各単語の頭文字を大文字にし、単語を連結する形式(キャメルケースと似ているが、最初の単語の頭文字も大文字)。.NETの文脈で使用。 | ExampleVariable
|
アッパーキャメルケース | upper camel case | パスカルケースと同じ形式だが、フレームワークや言語に依存しない表現。 | ExampleVariable
|
ケバブケース | kebab case | 単語間をハイフン(- )で繋ぎ、各単語の頭文字を小文字にする形式。
「チェインケース / チェーンケース(chain case)」とも呼ばれる[16]。 |
example-variable
|
トレインケース | train case | 単語間をハイフン(- )で繋ぎ、各単語の頭文字を大文字にする形式。
|
Example-Variable
|
ドットケース | dot case | 単語間をドット(. )で繋ぐ形式。
|
example.variable
|
脚注
注釈
出典
- ^ a b “Snake Case VS Camel Case VS Pascal Case VS Kebab Case – What's the Difference Between Casings?” (英語). freeCodeCamp.org (2022年11月29日). 2024年7月3日閲覧。
- ^ a b “What is Snake Case?” (英語). www.computerhope.com. 2024年7月3日閲覧。
- ^ a b “Dictionary of Terms · Geography Programming Courses”. www.geog.leeds.ac.uk. 2024年7月3日閲覧。
- ^ a b “Snake case - MDN Web Docs Glossary: Definitions of Web-related terms | MDN” (英語). developer.mozilla.org (2023年9月8日). 2024年7月10日閲覧。
- ^ a b rubocop/ruby-style-guide, RuboCop Headquarters, (2024) 2024年7月3日閲覧。
- ^ a b c d e “Naming Conventions”. ORACLE. 2024年7月3日閲覧。
- ^ a b c d e f g h i airbnb/javascript, Airbnb, (2024-07-03) 2024年7月3日閲覧。
- ^ a b “CppCoreGuidelines/CppCoreGuidelines.md at master · isocpp/CppCoreGuidelines” (英語). GitHub. 2024年7月3日閲覧。
- ^ a b “PHP: Rules - Manual”. www.php.net. 2024年7月3日閲覧。
- ^ a b c d e f g h i j k “PEP 8 – Style Guide for Python Code | peps.python.org” (英語). Python Enhancement Proposals (PEPs). 2024年7月3日閲覧。
- ^ a b “Variables and Mutability - The Rust Programming Language”. doc.rust-lang.org. 2024年7月3日閲覧。
- ^ a b “Cargo.toml conventions - The Rust Style Guide”. doc.rust-lang.org. 2024年7月3日閲覧。
- ^ “Constant Naming Convention | JavaScript syntax”. codefinity.com. 2024年7月3日閲覧。
- ^ “キャメルケース・パスカルケース・スネークケース・コンスタントケース・ケバブケースの違い【命名規則】”. IT Information (2024年2月5日). 2024年7月3日閲覧。
- ^ “Google JavaScript Style Guide”. google.github.io. 2024年7月4日閲覧。
- ^ a b c “スネークケースとは - IT用語辞典”. IT用語辞典 e-Words. 2024年7月7日閲覧。
- ^ Cwalina, Krzysztof; Abrams, Brad (2008-10-22) (英語). Framework Design Guidelines: Conventions, Idioms, and Patterns for Reusable .NET Libraries. Pearson Education. ISBN 978-0-321-60500-9
- ^ Skeet, Jon (2019-03-23) (英語). C# in Depth: Fourth Edition. Manning Publications. ISBN 978-1-61729-453-2
- ^ “Build software better, together” (英語). GitHub. 2024年7月3日閲覧。
- ^ “Reddit - Dive into anything”. www.reddit.com. 2024年7月3日閲覧。
- ^ “Stack Overflow - Where Developers Learn, Share, & Build Careers” (英語). Stack Overflow. 2024年7月3日閲覧。
- ^ “DEV Community => Search Results” (英語). DEV Community. 2024年7月3日閲覧。
- ^ a b c d Kernighan, Brian W.; Ritchie, Dennis M. (1978) (英語). The C Programming Language. Prentice-Hall. ISBN 978-0-13-110163-0
- ^ a b c d King, Kim N. (1996) (英語). C Programming: A Modern Approach. Norton. ISBN 978-0-393-96945-0
- ^ a b c McConnell, Steve (1993) (英語). Code Complete: A Practical Handbook of Software Construction. Microsoft Press
- ^ a b c d e f g h i j k Martin, Robert C. (2008-08-01) (英語). Clean Code: A Handbook of Agile Software Craftsmanship. Pearson Education. ISBN 978-0-13-608325-2
- ^ “Coding Guidelines — The Linux Kernel documentation”. docs.kernel.org. 2024年7月3日閲覧。
- ^ “GNU Coding Standards”. www.gnu.org. 2024年7月3日閲覧。
- ^ “style(9)”. man.freebsd.org. 2024年7月3日閲覧。
- ^ “camelcase - ESLint - Pluggable JavaScript Linter” (英語). eslint.org. 2024年7月3日閲覧。
- ^ “id-match - ESLint - Pluggable JavaScript Linter” (英語). eslint.org. 2024年7月3日閲覧。
- ^ a b c d Thomas, David; Hunt, Andrew (2019-07-30) (英語). The Pragmatic Programmer: Your journey to mastery, 20th Anniversary Edition. Addison-Wesley Professional. ISBN 978-0-13-595691-5
- ^ a b c Matthes, Eric (2019-05-03) (英語). Python Crash Course, 2nd Edition: A Hands-On, Project-Based Introduction to Programming. No Starch Press. ISBN 978-1-59327-928-8
- ^ a b c d Bloch, Joshua (2024) (英語). Effective Java (3rd Edition). Ren min you dian chu ban she. ISBN 978-7-115-62899-2
- ^ a b c d Mcconnell, Steve (英語). Code Complete, 2nd Edition. Wiley India Pvt. Limited. ISBN 978-93-5004-124-6
- ^ a b Goetz, Brian (2006) (英語). Java Concurrency in Practice. Addison-Wesley. ISBN 978-0-321-34960-6
- ^ a b c Kleppmann, Martin (2017-03-16) (英語). Designing Data-Intensive Applications: The Big Ideas Behind Reliable, Scalable, and Maintainable Systems. "O'Reilly Media, Inc.". ISBN 978-1-4919-0311-7
- ^ a b Beyer, Betsy; Jones, Chris; Petoff, Jennifer; Murphy, Niall Richard (2016-03-23) (英語). Site Reliability Engineering: How Google Runs Production Systems. "O'Reilly Media, Inc.". ISBN 978-1-4919-5118-7
- ^ a b Karwin, Bill (2010) (英語). SQL Antipatterns: Avoiding the Pitfalls of Database Programming. Pragmatic Bookself. ISBN 978-1-68050-007-3
- ^ a b Hernandez, Michael J. (2021-07-27) (英語). Database Design for Mere Mortals: A Hands-On Guide to Relational Database Design. Addison-Wesley. ISBN 978-0-13-312227-5
- ^ Osmani, Addy (2023-04-28) (英語). Learning JavaScript Design Patterns. "O'Reilly Media, Inc.". ISBN 978-1-0981-3983-4
- ^ Sweigart, Al (2019-11-12) (英語). Automate the Boring Stuff with Python, 2nd Edition: Practical Programming for Total Beginners. No Starch Press. ISBN 978-1-59327-992-9
関連項目
- スクリーミングスネークケースのページへのリンク