CA1707: Identifikátory by neměly obsahovat podtržítka
| Vlastnost | Hodnota |
|---|---|
| ID pravidla | CA1707 |
| Název | Identifikátory by neměly obsahovat podtržítka |
| Kategorie | Pojmenování |
| Oprava způsobující chybu nebo chybu způsobující chybu | Přerušení – při vyvolání u sestavení Nerozbití – při vyvolání u parametrů typu |
| Povoleno ve výchozím nastavení v .NET 9 | No |
Příčina
Název identifikátoru obsahuje znak podtržítka (_).
Popis pravidla
Názvy identifikátorů podle konvence neobsahují znak podtržítka (_). Pravidlo kontroluje obory názvů, typy, členy a parametry.
Konvence vytváření názvů poskytují společný vzhled knihoven, které cílí na modul CLR (Common Language Runtime). To snižuje křivku učení, která je nutná pro nové softwarové knihovny, a zvyšuje důvěru zákazníků, že knihovna byla vyvinuta někým, kdo má zkušenosti s vývojem spravovaného kódu.
Jak opravit porušení
Odeberte z názvu všechny znaky podtržítka.
Kdy potlačit upozornění
Nepotlačujte upozornění pro produkční kód. Je však bezpečné potlačit toto upozornění pro testovací kód.
Potlačení upozornění
Pokud chcete pouze potlačit jedno porušení, přidejte do zdrojového souboru direktivy preprocesoru, abyste pravidlo zakázali a znovu povolili.
#pragma warning disable CA1707
// The code that's violating the rule is on this line.
#pragma warning restore CA1707
Pokud chcete pravidlo pro soubor, složku nebo projekt zakázat, nastavte jeho závažnost v none konfiguračním souboru.
[*.{cs,vb}]
dotnet_diagnostic.CA1707.severity = none
Další informace naleznete v tématu Jak potlačit upozornění analýzy kódu.
U dobře známých metod v kódu Microsoftu, které aktuálně používají podtržítko a nelze je změnit, by mělo být pravidlo potlačeno.
Konfigurace kódu pro analýzu
Pomocí následující možnosti nakonfigurujte, ve kterých částech základu kódu se má toto pravidlo spouštět.
Tuto možnost můžete nakonfigurovat jenom pro toto pravidlo, pro všechna pravidla, která platí, nebo pro všechna pravidla v této kategorii (pojmenování), na která platí. Další informace naleznete v tématu Možnosti konfigurace pravidla kvality kódu.
Zahrnutí konkrétních povrchů rozhraní API
Na základě přístupnosti můžete nakonfigurovat, na kterých částech základu kódu se má toto pravidlo spouštět. Pokud chcete například určit, že pravidlo by se mělo spouštět jenom na neveřejné ploše rozhraní API, přidejte do souboru .editorconfig v projektu následující pár klíč-hodnota:
dotnet_code_quality.CAXXXX.api_surface = private, internal
