CA1709: 識別子では、大文字と小文字が正しく区別されなければなりません
Item | [値] |
---|---|
規則 ID | CA1709 |
カテゴリ | Microsoft.Naming |
互換性に影響する変更点 | 破壊的 - アセンブリ、名前空間、型、メンバー、およびパラメーターで発生した場合。 非破壊的 - 型パラメーターで発生した場合。 |
原因
識別子の名前の大文字と小文字が正しくありません。
または
識別子の名前に 2 文字の頭字語が含まれ、2 番目の文字が小文字です。
または
識別子の名前に、3 文字以上の大文字の頭字語が含まれています。
規則の説明
名前付け規則では、共通言語ランタイムをターゲットとするライブラリの統一的な名前の付け方が規定されています。 この一貫性により、新しいソフトウェア ライブラリを習得するまでの時間を短縮でき、マネージド コード開発の専門家によってライブラリが開発されたという信頼を顧客に与えることができます。
名前付け規則では、パラメーター名にはキャメル ケースが使用され、名前空間、型、およびメンバーの名前にはパスカル ケースが使用されます。 キャメル ケースの名前では、最初の文字が小文字で、名前に含まれる残りの単語の最初の文字が大文字になります。 キャメル ケースの名前の例は、packetSniffer
、ioFile
、および fatalErrorCode
です。 パスカル ケースの名前では、最初の文字が大文字で、名前に含まれる残りの単語の最初の文字が大文字になります。 パスカル ケースの名前の例は、PacketSniffer
、IOFile
、および FatalErrorCode
です。
この規則では、大文字と小文字の区別に基づいて名前が単語に分割され、2 文字の単語はすべて一般的な 2 文字語 ("In" や "My" など) の一覧に対してチェックされます。 一致するものが見つからないと、その単語は頭字語であると見なされます。 さらに、この規則では、連続した 4 個または 3 個の大文字が名前の末尾に含まれていると、それらは頭字語であると見なされます。
慣例として、2 文字の頭字語ではすべて大文字が使用され、3 文字以上の頭字語ではパスカル ケースが使用されます。 たとえば、'DB'、'CR'、'Cpa'、および 'Ecma' では、この名前付け規則が使用されています。 たとえば、'Io'、'XML'、および 'DoD'、またパラメーター以外の名前である 'xp' および 'cpl' は、この規則に違反しています。
'ID' はこの規則に違反する特別なケースです。 'Id' は頭字語ではなく 'identification' の省略形です。
違反の修正方法
大文字と小文字が正しくなるように名前を変更します。
どのようなときに警告を抑制するか
独自の名前付け規則がある場合、または識別子が固有名詞 (会社またはテクノロジの名前など) を表す場合は、この警告を抑制しても問題ありません。
また、特定の用語、略語、および頭字語を、コード分析カスタム辞書に追加することもできます。 カスタム辞書に指定された用語が、この規則の違反を引き起こすことはありません。 詳細については、「方法 : コード分析辞書をカスタマイズする」を参照してください。
関連規則
フィードバック
https://aka.ms/ContentUserFeedback」を参照してください。
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「フィードバックの送信と表示