2016-10-20 3 views
1

Один из моих классов имеет общедоступное свойство с именем Ttl. Это должно следовать CA1709 правилам:Как правильно добавить аббревиатуры в CustomDictionary.xml

По соглашению, две буквенные аббревиатуры использовать все заглавные буквы, и аббревиатуры из трех или более символов использовать Pascal корпус. Следующие примеры используют это соглашение об именах: «DB», «CR», «Cpa» и «Ecma». Следующие примеры нарушают соглашение: «Io», «XML» и «DoD», и имена непараметров «xp» и «cpl».

Теперь анализ кода жалуется на мою собственность, заявив, что она нарушает 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> 

Я попытался положить нижний, верхний и ГорбатыйРегистр в словарь, но ни один из них не удалит орфографическую жалобу. Есть ли способ добавить этот акроним в XML или мне просто нужно подавить сообщение для моего правильно названного свойства?

ответ

1

Вы добавили «Ttl» в качестве исключения для обсадной колонны. На самом деле это не. Это три буквы в случае Паскаля.

Что вы не делали, это добавить «Ttl» в качестве слова.

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

Убедитесь, что он вам вообще нужен. Большинство языков .NET имеют «без аббревиатур» как хорошее соглашение об именах.

+0

Класс является оберткой вокруг сокета, у которого есть свойство Ttl, поэтому я не хочу менять имя. Так что, на ваш взгляд, я должен, вероятно, просто подавить этот исключительный случай, верно? –

+1

Принял ответ, так как это * правильный ответ на мой оригинальный вопрос. :) –

+1

Лично я бы назвал его 'TimeToLive'. Построение обертки не является основанием для того, чтобы заключить соглашение об именовании не.NET. Я бы ожидал, что оболочка придет с соглашениями, которые она обертывает * в *. – nvoigt

Смежные вопросы