【完全網羅】プログラミング命名規則。言語別、記法、定番の変数名

2023.06.11

命名規則の重要性と利点

命名規則はプログラミングにおいて重要な役割を果たします。適切な命名規則を使用することにより、以下の利点を得ることができます。

  • 可読性の向上: 適切な命名規則を使用すると、コードを読む人が変数や関数の役割や目的を理解しやすくなります。そのため、他の開発者がコードを追いやすくなり、コラボレーションがスムーズになります。
  • メンテナンス性の向上: 良い命名規則を使用すると、コードの保守や修正が容易になります。変数や関数の名前から意図を推測しやすくなるため、バグの特定や機能の拡張が効率的に行えます。
  • 可搬性の向上: 命名規則に従って一貫性のあるコードを作成することで、プログラムを異なるプラットフォームや環境に移植する際の作業が容易になります。

ケーススタイルの一覧

キャメルケース (camelCase)

  • 単語の先頭を小文字、後続の単語の先頭を大文字で表記します。
  • 例: camelCase

スネークケース (snake_case)

  • 単語をアンダースコア _ でつなぎます。
  • 例: snake_case

パスカルケース (PascalCase)

  • 単語の先頭を大文字で表記し、後続の単語も先頭を大文字で表記します。
  • 例: PascalCase

コンスタントケース (CONSTANT_CASE)

  • 単語を大文字で表記し、単語をつなぐ際にアンダースコア _ でつなぎます。
  • 例: CONSTANT_CASE

チェインケース (chain-case)

  • 単語をハイフン - でつなぎます。
  • 例: chain-case

ケバブケース (kebab-case)

  • チェインケースと同様に単語をハイフン - でつなぎます。
  • 例: kebab-case

これらはプログラミングにおいて一般的に使用されるケーススタイルです。それぞれのスタイルには特定のルールがあり、コードの可読性や一貫性を向上させる役割があります。適切なケーススタイルを選び、プロジェクト内で一貫して使用することが重要です。

命名規則におけるメタデータと命名手法

単語連結法 (OF Language)

単語連結法 (OF Language) は、変数や関数の命名において、単語を連結して使う命名規則です。単語連結法は可読性が高く、意図が明確に伝わる命名方法として一般的です。

この命名規則では、複数の単語を連結して、変数や関数の名前を作成します。連結する際には、通常は各単語の先頭を大文字で始めます (パスカルケース)。これにより、単語ごとの区別が容易になり、読みやすい命名が実現できます。

例えば、以下は単語連結法の例です:

calculateTotalAmount
getUserInfo
sendMessageToAdmin

上記の例では、各単語が連結されているため、変数や関数の目的や役割が明確に表現されています。読み手に対して、コードの意図が直感的に伝わることが期待されます。

単語連結法は、変数や関数の命名において一般的に推奨される命名規則の一つです。ただし、長い命名になりすぎると可読性が低下する可能性があるため、適度な長さと明確さを保つように注意が必要です。

ハンガリアン記法

ハンガリアン記法は、変数や関数の名前の先頭にデータ型や意味を表す接頭辞を付ける方法です。ただし、近年ではこの記法はあまり推奨されておらず、多くのプログラミング言語では推奨されないか、避けることが一般的です。以下に具体的な例を示します。

例1: 整数を表す変数には “i” を接頭辞として付ける。

int iCount = 10;

例2: 文字列を表す変数には “str” を接頭辞として付ける。

string strName = "John";

例3: ブール値を表す変数には “b” を接頭辞として付ける。

bool bIsLoggedIn = false;

例4: 配列を表す変数には “arr” を接頭辞として付ける。

int[] arrNumbers = {1, 2, 3, 4};

ハンガリアン記法では、変数の型や役割を名前に直接反映させることで、コードの可読性を向上させる意図があります。しかし、近年のプログラミングのトレンドでは、型推論や明示的な命名などの方法が推奨されています。これにより、変数の意味が名前だけでなく、コンテキストからも理解できるようになります。

ハンガリアン記法の問題点としては、以下のような点が挙げられます。

  • 型推論の普及: 現代のプログラミング言語では、コンパイラやインタプリタが型を推論する能力が高まっています。そのため、明示的な型情報を変数名に含める必要が少なくなりました。
  • 複雑さと保守性の低下: ハンガリアン記法では、変数名にデータ型に関する情報が含まれるため、変数の型を変更する場合には変数名の修正も必要となります。これはコードの保守性を低下させる可能性があります。
  • リファクタリングの困難さ: ハンガリアン記法では変数名にデータ型が含まれるため、変数のリファクタリングが困難になります。変数の役割や意味が変わった場合には、変数名の修正が必要となります。

そのため、ハンガリアン記法の使用は避けることが推奨されており、代わりに適切な変数名を使用することが一般的です。変数名が適切に選ばれ、コンテキストから推測できる場合、ハンガリアン記法よりも可読性が向上し、保守性が高まります。

変数名に番号を付ける命名規則

変数名に番号を付ける命名規則は、変数名の末尾に連番の数字を追加する方法です。このような命名規則は一般的には推奨されませんが、一部の特定のケースで使用されることがあります。

例えば、以下のような命名規則が変数名に番号を付ける例です:

data1
data2
data3

上記の例では、変数名の末尾の数字が異なるため、それぞれの変数が異なるデータを表すことがわかります。しかし、このような命名規則は可読性や保守性に影響を与える可能性があります。

数字だけでは変数の役割や意味が明確にならず、他のコンテキストやコメントのない限り、その数字が何を表しているのかを理解するのは難しいです。また、変数の追加や削除時には、変数名の修正や連番の更新が必要となり、保守性の低下や混乱を招く可能性があります。

そのため、変数名に番号を付ける代わりに、意味のある具体的な変数名を選択することを推奨します。変数の役割や意味を明示し、コードの可読性と保守性を向上させるために、より適切な命名規則を使用することが重要です。

したがって、一般的には変数名に番号を付ける命名規則は推奨されず、意味のある変数名を使用することが最善の方法です。

変数、関数、メソッド名の付け方と具体例

良い変数名とは

  • 読みやすく意味のある名前: 変数の役割や目的が名前から推測できるようにします。例えば、studentName、totalAmount などが良い変数名の例です。
  • ケーススタイルの統一: プロジェクト内で一貫性のあるケーススタイルを選び、変数名に適用します。例えば、camelCase や snake_case などです。
  • 適切な長さ: 変数名は短すぎず、かといって長すぎないようにします。名前が長すぎると可読性が低下する場合があります。

良い関数/メソッド名の付け方と具体例

  • 操作の目的がわかる名前: 関数やメソッドの目的や操作内容が名前から明確に理解できるようにします。例えば、calculateTotal()、getUserInfo() などが良い関数/メソッド名の例です。
  • 動詞を使用する: 関数やメソッドの名前には動詞を含めることで、何を行っているのかを明示します。例えば、calculateTotal()、getUserInfo() などが良い例です。
  • ケーススタイルの統一: 変数と同様に、関数やメソッドの名前にも一貫性のあるケーススタイルを適用します。

変数名・関数/メソッド名で使える英単語の例

変数名や関数/メソッド名にはさまざまな英単語を使用することができます。以下にいくつかの例を示します。

  • user
  • name
  • age
  • count
  • total
  • calculate
  • validate
  • get
  • set
  • add
  • remove

言語固有の命名規則: C/C++、Java、Python、Javascript、Ruby、Go、Rust、Swift、Kotlin、TypeScript、C$

C/C++、Java、Python、JavaScript、Ruby、Go、Rust、Swift、Kotlin、TypeScript、C#などの言語固有の命名規則の一般的な例を示します。

C/C++

  • ケーススタイル: スネークケースが一般的です。
  • ハンガリアン記法: 変数や関数の接頭辞にデータ型や意味を表す接頭辞を付けることがあります。

例:

int player_score;
float average_temperature;

Java

  • ケーススタイル: パスカルケースが一般的です。クラス名は大文字で始まり、変数やメソッドは小文字で始まります。

例:

public class Car {
    private String brand;

    public void startEngine() {
        // エンジンを始動する処理
    }
}

Python

  • ケーススタイル: スネークケースが一般的です。

例:

player_score = 10
average_temperature = 25.5

クラス名など変数以外の命名基礎については次の記事にまとめています。

Pythonの命名規則について徹底解説
Pythonのプログラムを書く際には、変数や関数、クラスなどの識別子の名前に適切な命名規則を守ることが重要です。本記事では、Pythonの命名規則について、具体的なルールや重要性、変更方法などについて説明します。まずはじめにPyt...
odigo.jp
2023.03.11

JavaScript

  • ケーススタイル: キャメルケースが一般的です。

例:

let playerScore = 10;
const averageTemperature = 25.5;

Ruby

  • ケーススタイル: スネークケースが一般的です。

例:

player_score = 10
average_temperature = 25.5

Go

  • ケーススタイル: パスカルケースが一般的です。

例:

type Car struct {
    Brand string
}

func StartEngine() {
    // エンジンを始動する処理
}

Rust

  • ケーススタイル: スネークケースが一般的です。

例:

let player_score = 10;
const AVERAGE_TEMPERATURE: f32 = 25.5;

Swift

  • ケーススタイル: パスカルケースが一般的です。

例:

var playerScore = 10
let averageTemperature = 25.5

Kotlin

  • ケーススタイル: パスカルケースが一般的です。

例:

var playerScore = 10
val averageTemperature = 25.5

TypeScript

  • ケーススタイル: キャメルケースが一般的です。

例:

let playerScore = 10;
const averageTemperature = 25.5;

C#

  • ケーススタイル: パスカルケースが一般的です。

例:

int playerScore = 10;
const float averageTemperature = 25.5f;

これらは一部のプログラミング言語における一般的な命名規則の例です。ただし、各言語にはさまざまなスタイルガイドやコーディング規約が存在するため、具体的なプロジェクトやチームの規則に従うことが重要です。

命名規則に対する業界のスタンダード

Google、Microsoftなど大手企業の命名規則

多くの大手企業は独自の命名規則を定めています。GoogleやMicrosoftなどは公開されたスタイルガイドやベストプラクティスを提供しており、それらを参考にすることができます。

Google Style Guides
Style guides for Google-originated open-source projects
google.github.io
.NET ドキュメントの C# のコーディング規則 - C#
C# でよく使われるコーディング規則について説明します。 コーディング規則によってコードの外観に一貫性がもたらされ、コードのコピー、変更、保守が容易になります。 この記事には、ドキュメント リポジトリのコーディングのガイドラインも含まれています
learn.microsoft.com

オープンソースプロジェクトの命名規則

オープンソースプロジェクトは多くの開発者が参加するため、一貫性のある命名規則が重要です。オープンソースプロジェクトでは、プロジェクトのルールに従った命名規則を適用することが一般的です。

まとめと注意点

プログラミングの命名規則の重要性

適切な命名規則を使用することは、可読性や保守性、可搬性などの観点からプログラムの品質を向上させるために重要です。

命名規則に従って高品質なコードを書くためのアドバイス

以下のアドバイスに従って、高品質なコードを書くために命名規則を活用しましょう。

  • 目的や役割を反映する意味のある名前を使用する。
  • 一貫性のあるケーススタイルを適用する。
  • スペルやタイプミスに注意し、正確な名前を使用する。

これらの命名規則とアドバイスを守ることにより、より理解しやすく、保守性の高いプログラムを作成することができます。

コメント

タイトルとURLをコピーしました