CA1726:使用首选词条

适用范围:yesVisual Studio noVisual Studio for Mac noVisual Studio Code

“值”
RuleId CA1726
Category Microsoft.Naming
重大更改 中断 - 在程序集上引发时

非中断 - 在类型参数上引发时

原因

在外部可见的标识符的名称中,包括一个存在首选备用词条的词条。 或者,名称中包含“Flag”或“Flags”一词。

规则说明

此规则将标识符分析为标记。 每个标记和每个连续的双标记组合与规则中内置的词以及任何自定义字典的“已弃用”部分中的词进行比较。 下表显示了规则中内置的词及其首选替代项。

过时的词 首选词
Arent AreNot
Cancelled Canceled
Cant Cannot
ComPlus EnterpriseServices
Couldnt CouldNot
Didnt DidNot
Doesnt DoesNot
Dont DoNot
FlagFlags 没有替换词。 请勿使用。
Hadnt HadNot
Hasnt HasNot
Havent HaveNot
Indices Indexes
Isnt IsNot
LogIn LogOn
LogOut LogOff
Shouldnt ShouldNot
SignOn SignIn
SignOff SignOut
Wasnt WasNot
Werent WereNot
Wont WillNot
Wouldnt WouldNot
Writeable Writable

如何解决冲突

若要解决此规则冲突,请将词替换为首选的替换词。

何时禁止显示警告

仅当标识符的名称是有意的且与原始词(而不是首选词)相关时,才禁止显示此规则的警告。

命名警告