このセクションでは、一般的な名前付け規則を説明する。
具体的には、単語の選択、省略形と頭字語のガイドライン、言語固有の名前を避けるための推薦事項を説明する。
✓ 読みやすい名前を選択しよう。正しい英文法に従った表記をこころがけよう。
HorizontalAlignment というプロパティ名は、AlignmentHorizontal より読みやすい。
✓ 簡潔さよりも読みやすさを優先しよう。
CanScrollHorizontally というプロパティ名は ScrollableX
よりも優れている。ScrollableXとは何を意味するのか、あいまいだ。
✖ アンダースコア、ハイフン、またはその他の英数字以外の文字を使用してはならない。
唯一の例外としてプロパティバッキングストアのフィールド名には、プロパティ名にアンダースコア「_」の接尾辞を付ける。
✖ ハンガリアン記法の使用を禁止する。
✖ プログラミング言語のキーワード（予約語）と競合する名前を避けよう。
共通言語仕様 (CLS) に準拠するすべての言語は、その言語のキーワードを名前として使用するメカニズムを提供している。
たとえば、C#では@記号をエスケープシーケンスとして提供している。
ただし、エスケープシーケンスと共にメソッドを使用すると可読性が下がるため、一般的なキーワードを避けよう。
✖ 名前の一部として、省略形や短縮形を使用してはならない。
たとえば、GetWinではなく GetWindow を使おう。
✖ 広く受け入れられていない頭字語を使用してはならない。
判断基準があいまいなので使っても良い頭字語を具体的に列挙しておこう。2文字目以降の大文字・小文字の判断も下記に従うこと。
✓ 型の名前には言語固有（C#固有）のキーワードではなく、意味がわかりやすい名前を使おう。
たとえば、 GetLength は GetInt よりも優れた名前だ。
✓名前に型名を使いたい場合は、言語固有の型名ではなく、汎用CLR
の型名を使おう。
たとえば、Int64 に変換するメソッドは ToLong ではなく ToInt64 と名付ける。
なぜなら、Int64 は CLR 型名であり、long とは Int64 の C# 固有のエイリアスだからだ。
|
C# |
Visual Basic |
C++ |
CLR 型名 |
|---|---|---|---|
|
sbyte |
SByte |
char |
SByte |
|
byte |
Byte |
unsigned char |
Byte |
|
short |
Short |
short |
Int16 |
|
ushort |
UInt16 |
unsigned short |
UInt16 |
|
int |
Integer |
int |
Int32 |
|
uint |
UInt32 |
unsigned int |
UInt32 |
|
long |
Long |
__int64 |
Int64 |
|
ulong |
UInt64 |
unsigned __int64 |
UInt64 |
|
float |
Single |
float |
Single |
|
Double |
Double |
Double |
Double |
|
bool |
Boolean |
bool |
Boolean |
|
char |
Char |
wchar_t |
Char |
|
string |
String |
String |
String |
|
object |
Object |
Object |
Object |
✓ 識別子が意味論的な意味を持たず、パラメーターの型が重要でない場合は、型名を繰り返すのではなく、value または item のような共通の名前を使おう。
✓ 既存の API の新しいバージョンを作成するときに、古い API
の名前に近い名前を使おう。
このガイドラインに従うことで新旧 API の関連性を強調できる。
✓ 既存の API
の新しいバージョンを示すには、接頭辞ではなく、接尾辞を付けよう。
このガイドラインに従うことで、ドキュメントを検索したり Intellisense を使うときに新しい API を見付けやすくなる。
ほとんどのブラウザーおよび Intellisense はアルファベット順に識別子を表示するので、新旧 API は近くに整理されるようになる。
✓ 接尾辞を付ける代わりに、まったく新しい、より適切な名前を付けられないか検討してみよう。
✓ 既存の API の名前が唯一の意味のある名前 (つまり、業界標準である) 場合は、既存の API の新しいバージョンを示す数値の接尾辞を使って、名前を付けよう。
✖ 接尾辞「ーEx」（やこれに類似した接尾辞）を使って、同じ API の以前のバージョンを区別してはならない。
✓ 64ビット API
のバージョンを新たに導入するときは「ー64」接尾辞を使おう。
既存の32ビット API が存在するときのみ、このガイドラインに従おう。64ビット版しかない新しい API には、このガイドラインは適用しない。
