Заглавная буква аббревиатуры, которая запускает параметр - PullRequest
5 голосов
/ 21 июня 2010

У меня есть переменная, которая указывает продолжительность времени простоя пользовательского интерфейса.Я решил назвать эту переменную UITimer.Я хочу передать переменную в конструктор классов, а затем сохранить ее в локальном поле.

Как правильно сделать это?Мы используем общее соглашение для параметра, который не пишется с заглавной буквы.Поэтому я должен сделать это:

uITimer

или это?

uiTimer

Кроме того, мы делаем первую и нижнюю буквы для наших полей.

Должно ли это быть объявлено так:

 private int _uITimer

или как это

 private int _uiTimer?

Я думаю, что _uiTimer - это путь (другой вариант кажется неудачным), ноМне интересно узнать, что я что-то упускаю.

Лучшим ответом будет ссылка на документ, в котором говорится, что все сокращения в именах C # должны быть одинаковыми (или что-то в этом роде)

1 Ответ

12 голосов
/ 21 июня 2010

Microsoft Framework Design Guidelines может сказать по этому поводу следующее:


3.1.2 Заглавные буквы

DO заглавные буквы двухсимвольных сокращений, кроме первого слова идентификатора в верблюжьей клетке.

System.IO
public void StartIO(Stream ioStream)

DO Прописывать только первый символ аббревиатур с тремя или более символами, кроме первого слова идентификатора в верблюжьей клетке.

System.Xml
public void ProcessHtmlTag(string htmlTag)

НЕ В начале идентификатора в верблюжьей клетке пишите заглавными буквами любые символы любых сокращений независимо от их длины.


В основном вы спрашивали о последнем из этих трех правил.

Лично я бы выбрал uiTimer, просто потому, что uITimer выглядит менее читабельным.

...