C++におけるアンダースコアの使用に関するルール
2024-09-28
C++において、アンダースコア（_）は識別子（変数名、関数名、クラス名など）に使用できます。ただし、特定の規則に従う必要があります。
規則
- 最初の文字: アンダースコアで始まる識別子は、予約語ではない限り、有効です。ただし、慣習的に、そのような識別子は内部使用またはライブラリに関連するものであるとみなされることが多いです。
- 予約語: アンダースコアを含む予約語（例えば、
__LINE__、__FILE__）は、特別な意味を持ちます。これらはプリプロセッサによって定義され、ソースファイルの行番号やファイル名を表します。
命名慣例
C++の命名慣例は、プロジェクトや組織によって異なる場合があります。しかし、一般的な慣例として、アンダースコアは以下のような場合に使用されます。
- 内部使用: プロジェクト内で使用するプライベートな変数や関数。
- ライブラリ: ライブラリで使用される変数や関数。
- マクロ: プリプロセッサマクロの定義。
例:
// 内部使用変数
int _internal_value;
// ライブラリ関数
void library_function();
// マクロ
#define PI 3.14159
注意:
- 予約語の誤用: 予約語を間違って使用すると、コンパイルエラーが発生します。
- 可読性: アンダースコアを過度に使用すると、コードの可読性が低下する可能性があります。適切な命名規則に従い、わかりやすい識別子を使用するように心がけましょう。
内部使用変数
int _internal_value = 10;
この例では、_internal_valueという名前の変数が宣言されています。アンダースコアで始まる名前は、通常、内部使用またはプライベートな変数であることを示します。
ライブラリ関数
void library_function() {
// 関数の処理
}
この例では、library_functionという名前の関数が定義されています。アンダースコアを含む名前は、ライブラリで使用される関数であることを示すことがあります。
マクロ
#define PI 3.14159
この例では、PIという名前のマクロが定義されています。マクロは、プリプロセッサによって処理されるテキスト置換であり、アンダースコアを含む名前が使用されることがあります。
命名規則の例
以下は、一般的なC++の命名規則に従ったアンダースコアの使用例です。
- クラス名:
MyClass - 変数名:
my_variable - 関数名:
get_value - 定数:
MAX_VALUE
これらの例では、アンダースコアは、単語を区切るために使用されています。
- 予約語の誤用: 予約語（例えば、
__LINE__、__FILE__）を間違って使用すると、コンパイルエラーが発生します。
アンダースコアの使用の代替方法として、以下のような方法が考えられます。
キャメルケース
- 単語の最初の文字を大文字にする:
myVariable,myFunction - 単語の境界を大文字で区切る:
myCamelCaseVariable,myCamelCaseFunction
スネークケース
- 単語の間にアンダースコアを挿入する:
my_variable,my_function
ハンガーケース
ミックスケース
- 複数の命名規則を組み合わせる:
myVariable,my_function
これらの命名規則は、プロジェクトや組織によって異なる場合があります。適切な命名規則を選択し、一貫して使用することで、コードの可読性と保守性を向上させることができます。
以下に、各命名規則の例を示します。
// キャメルケース
int myVariable = 10;
void myFunction() {
// 関数の処理
}
// スネークケース
int my_variable = 10;
void my_function() {
// 関数の処理
}
// ハンガーケース
int myVariable = 10;
void myFunction() {
// 関数の処理
}
// ミックスケース
int my_variable = 10;
void myFunction() {
// 関数の処理
}
c++ language-lawyer naming-conventions
