Question

我的一个类有一个名为Ttl的公共属性。这应该遵循CA1709规则：

按照惯例，两个字母的首字母缩略词使用全部大写字母，和 三个或更多字符的首字母缩写词使用Pascal大写。下列示例使用此命名约定：＆＃39; DB＆＃39;，＆＃39; CR＆＃39;，＆＃39; Cpa＆＃39;和＆＃39; Ecma＆＃39;。以下示例违反了惯例：＆＃39; Io＆＃39;，＆＃39; XML＆＃39;和＆＃39; DoD＆＃39;，对于非参数名称，＆＃39; xp＆＃39;和＆＃39; cpl＆＃39;。

现在，代码分析会抱怨我的财产，告诉我它违反CA1704（拼写错误）。

我尝试将它添加到我的CustomDictionary.xml中，如下所示：

<?xml version="1.0" encoding="utf-8" ?>
<Dictionary xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="CodeAnalysisDictionary.xsd">

  <!-- Some unimportant elements are here in the real file -->

  <Acronyms>
    <CasingExceptions>
      <Acronym>Ttl</Acronym>    <!--Time To Live-->
    </CasingExceptions>
  </Acronyms>

</Dictionary>

我尝试将lower，upper和camel case放入字典中，但没有一个会删除拼写投诉。有没有办法将这个首字母缩略词添加到XML中，还是只需要为正确命名的属性抑制消息？

Answer 1

您添加了“Ttl”作为套管例外。实际上它是而不是。这是帕斯卡案中的三个字母。

你没做的是添加“Ttl”作为单词。

<Words>
     <Recognized>
        <Word>Ttl</Word>

确保你完全需要它。大多数.NET语言都没有“缩写”作为一个好的命名约定。

如何正确地向AcronDictionary.xml

1 个答案: