名前付け規則
名前付け規則は、.NET デザイン ガイドラインの名前付け規則の順守をサポートします。
このセクションの内容
ルール | 説明 |
---|---|
CA1700:列挙型値に 'Reserved' という名前を指定しません | この規則では、"reserved" を含む名前の列挙体のメンバーは、現在使用されていなくても、将来的なバージョンでは名前を変更するか削除されるプレースホルダーと想定しています。 メンバーの名前変更や削除は、互換性に影響する変更点です。 |
CA1707:識別子はアンダースコアを含むことはできません | 名前付け規則では、識別子名にアンダースコア (_) 文字を含めることができません。 この規則により、名前空間、型、メンバー、およびパラメーターがチェックされます。 |
CA1708:識別子は、大文字と小文字の区別以外にも相違していなければなりません | 名前空間、型、メンバー、およびパラメーターの各識別子は、大文字/小文字以外のみでは区別できません。共通言語ランタイムを対象とする言語は、大文字と小文字を区別する必要はないためです。 |
CA1710:識別子は、正しいサフィックスを含んでいなければなりません | 名前付け規則によると、特定の基本型を拡張した型、特定のインターフェイスを実装する型、またはそのような型から派生される型は、基本型やインターフェイスに関連するサフィックスを名前に付けます。 |
CA1711:識別子は、不適切なサフィックスを含むことはできません | 規則では、特定の基本型を拡張する型、特定のインターフェイスを実装する型、またはそのような型から派生した型の名前にのみ、固有の予約済みサフィックスを末尾に付けます。 その他の型名では、予約済みのサフィックスを使用しないでください。 |
CA1712:列挙型値を型名のプレフィックスにしません | 型情報は開発ツールで表示されるため、列挙型のメンバー名には、型名のプレフィックスを付けません。 |
CA1713:イベントは、before または after プレフィックスを含むことはできません | イベント名が "Before" または "After" で始まっています。 特定のシーケンスで発生する関連イベントに名前を付ける場合、現在時制または過去時制を使用して、アクション シーケンスの相対的な位置を示します。 |
CA1714:フラグ列挙型は、複数形の名前を含んでいなければなりません | パブリック列挙体に System.FlagsAttribute 属性があり、その名前の末尾に "s" がありません。 FlagsAttribute でマークされた型は複数形の名前を持ちます。これは、この属性が複数の値を指定できることを示すからです。 |
CA1715:識別子は正しいプレフィックスを含んでいなければなりません | 外部から参照できるインターフェイスの名前が大文字の "I" から始まっていません。 外部から参照できる型またはメソッドのジェネリック型パラメーターの名前が、大文字の "T" から始まっていません。 |
CA1716:識別子はキーワードと同一にすることはできません | 名前空間の名前または型の名前が、プログラミング言語で、予約済みのキーワードと一致します。 名前空間と型の識別子は、共通言語ランタイムを対象にする言語で定義されているキーワードと一致しないようにします。 |
CA1717:FlagsAttribute 列挙型のみが複数形の名前を含んでいなければなりません | 名前付け規則では、列挙体の複数形の名前は同時に複数の列挙値を指定できることを意味します。 |
CA1720:識別子には型名を含めないでください | 外部から参照できるメンバーのパラメーター名にデータ型の名前が含まれているか、外部から参照できるメンバーの名前に言語固有のデータ型の名前が含まれています。 |
CA1721:プロパティ名は get メソッドと同一にすることはできません | パブリック メンバーまたはプロテクト メンバーの名前が、"Get" から始まっているか、パブリック プロパティまたはプロテクト プロパティの名前と一致します。 "Get" メソッドとプロパティには、それぞれの機能を明確に区別する名前を指定しなければなりません。 |
CA1724:型名は名前空間と同一にすることはできません | 型名は .NET 名前空間と同一にすることはできません。 この規則に違反すると、ライブラリが使いづらくなります。 |
CA1725:パラメーター名は基本宣言と同一でなければなりません | オーバーライド階層のパラメーターに対する一貫性のある名前付けによって、メソッド オーバーライドの有用性が高まります。 派生メソッドのパラメーター名が基本宣言のパラメーター名と異なる場合、メソッドが基本メソッドのオーバーライドであるか、またはメソッドの新しいオーバーライドであるかについて混乱が生じる可能性があります。 |
CA1727: 名前付きプレースホルダーに PascalCase を使用してください | ログ メッセージ テンプレートの名前付きプレースホルダーにはパスカルケースを使用します。 |
GitHub で Microsoft と共同作業する
このコンテンツのソースは GitHub にあります。そこで、issue や pull request を作成および確認することもできます。 詳細については、共同作成者ガイドを参照してください。
.NET