名前付け規則
名前付け規則は、.NET 設計ガイドラインの名前付け規則への準拠をサポートします。
このセクションでは、
ルール | 説明 |
---|---|
CA1700: 列挙値に "予約済み" という名前を付けないでください | この規則では、"予約済み" を含む名前を持つ列挙メンバーは現在使用されていませんが、将来のバージョンで名前を変更または削除するプレースホルダーであることを前提としています。 メンバーの名前変更または削除は重大な変更です。 |
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 を使用 | ログ メッセージ テンプレートの名前付きプレースホルダーには PascalCase を使用します。 |
GitHub で Microsoft と共同作業する
このコンテンツのソースは GitHub にあります。そこで、issue や pull request を作成および確認することもできます。 詳細については、共同作成者ガイドを参照してください。
.NET