プログラミング命名規則について ~ Pascal Case, Camel Case, Snake Case, Constant Case ~
どうも lingmu です。
今回は、プログラミング命名規則でよく目にする代表的なものについて書きます。
1. プログラミング命名規則とは
プログラミングを行うときの変数名や関数名、クラス名などの識別子の名称を決めるためのルールです。複数名での開発では、このルールを決めて開発を行うことが必須となります。もしルールを決めずに開発を行った場合、個々人の感覚で開発を行うことになるので、ソースコードの理解にムダな労力を費やすことになります。
2. 代表的な命名規則
代表的な命名規則には以下4つがあります。
(1)Pascal Case
(2)Camel Case
(3)Snake Case
(4)Constant Case
※上記以外にも Kebab Case, Chain Case などがありますが、ここでは割愛します。
3. Pascal Case
英語の複合語を一語で表記する際に、構成するそれぞれの語の先頭を大文字にするルールです。C# では基本的にこの Pascal Case が用いられます。例えば、1行書き出すメソッド名の場合は WriteLine、ファイル名を取得するメソッド名の場合は GetFileName と表記します。
4. Camel Case
英語の複合語を一語で表記する際に、構成するそれぞれの語のうち最初の語の先頭を小文字で表記し、それ以外の語の先頭を大文字にするルールです。C# のパラメータ名はこの Camel Case が用いられます。例えば、char型配列を表すパラメータ名の場合は charArray、不正なパス文字を表すパラメータ名の場合は invalidPathChar と表記します。
5. Snake Case
英語の複合語を一語で表記する際に、構成するそれぞれの語の間をアンダースコア( _ )で連結するルールです。例えば、1行書き出すメソッド名の場合は write_line、ファイル名を取得メソッド名の場合は get_file_name と表記します。
6. Constant Case
全てを大文字で表記するルールです。単語を組み合わせる場合はアンダースコア( _ )で連結します。定数に使用されることが一般的です。例えば、正常状態を表す定数名の場合は NORMAL_STATE、異常状態を表す定数名の場合は ABNORMAL_STATE とように表記します。
7. 参考サイト
■名前付けのガイドライン - Framework Design Guidelines
https://docs.microsoft.com/ja-jp/dotnet/standard/design-guidelines/naming-guidelines
■PEP8 - Pythonコーディング規約 -
https://pep8-ja.readthedocs.io/ja/latest/
8. おわり
以上です。