C#の命名規則について基礎から解説!Pascal形式・Camel形式・Camel 形式の特殊な命名規則

公開日時:   更新日時:
基本情報技術者試験の試験対策はこちら>>

SE
C#の命名規則とはなんですか?

PM
プログラミングにおける命名規則とはフィールドやメソッドなどの名前の記述ルールを統一することです。命名規則について詳しく紹介します。

C#の命名規則とは?


C#に限らずプログラミングをする上では、必ずコーディングルールを守るべきです。業務でプログラミングをする場合、他の人が読んでわかりやすいソースコードを記述する必要があるため、統一性を重視しないと開発作業が円滑に進められません。

コーディングルールの中でも命名規則は重要な要素になります。この記事ではマイクロソフトが推奨するC#の命名規則について説明するので是非ご覧下さい。

命名規則のメリット

プログラミングにおける命名規則とは、フィールドやメソッドなどの名前の記述ルールを統一することです。

プログラミングにおいて命名規則に従うメリットは、
・ソースコードの見た目が統一されるので、ソースコードを読むときに、内容をすぐに読み取りやすくなる
・ソースコードの修正やメンテナンスがしやすくなる
といったことがあります。

Pascal 形式について

マイクロソフトはC#でフィードやクラスやメソッドなどの名前をPascal 形式で記述することを推奨しています。Pascal 形式とは英単語の先頭を大文字にしてつなげるスタイルです。

例えばdot net frameworkをPascal 形式で記述すると、DotNetFrameworkになります。クラスや構造体の名前の命名規則はPascal 形式に従い、以下のようにします。

Pascal 形式を使用するケース

インターフェイスの場合はクラスや構造体と違って、以下のようにまず先頭にiの大文字のIを付けて、その後はPascal 形式で記述します。また末尾はableを付けます。

privateではないフィールド、プロパティ、イベント、メソッドは以下のようにPascal 形式で記述します。

Camel 形式について

Pascal 形式に似たCamel 形式というルールもあります。これは先頭のみ小文字で、後はPascal 形式と同じです。dot net frameworkならばdotNetFrameworkになります。C#でCamel 形式で記述するのは、以下のようなメソッドのパラメータ、ローカルフィールドです。

Camel 形式の特殊な命名規則

クラスのメンバでprivateかinternalなフィールドはCamel 形式にして、さらに先頭に_を付けます。staticでprivateかinternalなフィールドは先頭にs_をつけます。スレッド静的である場合は先頭にt_を付けます。これはC#特有の命名規則と言えるでしょう。

メソッドの命名規則

C#のメソッドには一定の命名規則があります。インスタンスを帰すメソッド名は先頭にCreateかNew、TrueかFalseを帰すメソッド名は先頭にIsかCanかHas、型変換を行うメソッド名は先頭にToを付けます。これにより一目でメソッドの機能がわかるようになります。

非同期メソッドの命名規則

非同期で動作するメソッドの名前には、以下のように末尾にAsyncを付けます。

forループで使用する変数の名前

forループで使用する変数の名前はiを使用します。

二重の場合は2つ目はj、三重の場合は3つ目はkです。これはindexのiを取ったルールで、C#に限らず他の多くの言語で古くから採用されている命名規則です。四重なら4つ目はlになりますが、ループのネストはなるべく少なくするようにしましょう。

抽象クラスの命名規則

抽象クラスの名前も通常のクラスと同様にPascal 形式にします。そして末尾にBaseを付けましょう。デリゲートも通常のメソッドと同様にPascal 形式ですが、末尾にはCallbackを付けます。イベント用の場合はEventHandlerを付けましょう。

列挙子の命名規則

列挙子の場合はPascal 形式で命名します。以下のようになります。

コーディング規則について

命名規則とは違う分野になりますが、マイクロソフトが推奨するC#のコーディング規則には以下のようなものがあります。しっかり守って綺麗なソースコードを記述しましょう。

・1つの行には1つの命令文のみを記述する
・1つの行には1つの宣言のみを記述する
・インデントは4文字スペースを使用する
・メソッド定義とプロパティ定義の間に 1 行の空白行を追加する
・以下のように式に句を作成するときはかっこを使用する

コメントについて

C#の//ではじまるコメントについてもルールがあります。まずコメントは、コード行の末尾ではなく別の行に記述します。コマンドの右横に記述はしないということです。また//とコメントの間には、スペースを1つ入れます。

SE
C#の命名規則についてよくわかりました。

PM
命名規則を守って読みやすいプログラミングソースコードを書くようにしましょう。

C#の命名規則を守って綺麗なソースコードを記述しよう

C#の命名規則について解説しましたが、ご理解頂けましたでしょうか。命名規則を守らずにプログラミングをしても、動作しないということはありません。しかしチームで開発するのであれば第三者が読みやすいソースコードを書くことは必須です。

この記事のルールを守って、是非綺麗なソースコードを書き上げてください。


FEnetへの登録は左下のチャットが便利です 経験者優遇! 最短10秒!

.NET分野でのキャリアアップをお考えの方は、現在募集中の求人情報をご覧ください。

また、直接のエントリーも受け付けております。

エントリー(応募フォーム)

Search

Popular

reccomended

Categories

Tags