Соглашения о написании прописными буквами
Многие из соглашений об именовании относятся к использованию регистров в именах идентификаторов. Важно заметить, что среда CLR поддерживает как регистрозависимые, так и регистронезависимые языки. Соглашения о написании прописными буквами, описанные в этом разделе, облегчают разработчикам изучение и работу с библиотекой.
Стили использования регистров
Ниже описаны различные способы написания идентификаторов.
Стиль Pascal
Первая буква идентификатора и первая буква каждого последующего присоединенного слова являются прописными. Стиль Pascal можно использовать для идентификаторов, состоящих из трех и более букв. Примеры.
BackColor
Стиль Camel ("верблюжий")
Первая буква идентификатора является строчной, а первая буква каждого последующего присоединенного слова — прописной. Примеры.
backColor
Прописные буквы
Все буквы в идентификаторе являются прописными. Примеры.
IO
Правила использования прописных букв в идентификаторах
Когда идентификатор состоит из нескольких слов, не рекомендуется использовать между словами разделители, такие как подчеркивание (_) и дефис (-). Вместо этого следует использовать регистры для индикации начала каждого слова.
Ниже приведены общие правила для написания идентификаторов.
Используйте стиль Pascal для всех публичных членов, типов и пространств имен, состоящих из нескольких слов.
Обратите внимание на то, что это правило неприменимо к полям экземпляров. По причинам, описанным в Правила разработки членов, не следует использовать публичные поля экземпляров.
Для имен параметров используйте стиль Camel.
В следующей таблице приведена сводка правил использования прописных букв в идентификаторах и представлены примеры различных типов идентификаторов.
Идентификатор |
Case |
Пример |
|---|---|---|
Класс |
Pascal |
AppDomain |
Тип перечисления |
Pascal |
ErrorLevel |
Значения перечисления |
Pascal |
FatalError |
Событие |
Pascal |
ValueChanged |
Класс исключения |
Pascal |
WebException |
Статическое поле только для чтения |
Pascal |
RedValue |
Интерфейс |
Pascal |
IDisposable |
Метод |
Pascal |
ToString |
Пространство имен |
Pascal |
System.Drawing |
Параметр |
Camel |
typeName |
Свойство |
Pascal |
BackColor |
Правила использования прописных букв в акронимах
Акронимом называется слово, составленное из первых букв терминов или фраз. Например, HTML является акронимом для "Hypertext Markup Language". Акронимы следует включать в идентификаторы, только если они хорошо известны и понятны. Акронимы отличаются от аббревиатур тем, что аббревиатура в английском языке является сокращением одного слова. Например, ID является аббревиатурой для identifier. В общем случае имена в библиотеке не должны использовать аббревиатуры.
Примечание
Две аббревиатуры, которые можно использовать в качестве идентификаторов: ID и OK.В идентификаторах стиля Pascal они должны выглядеть так: Id и Ok.При использовании в качестве первого слова в идентификаторе стиля Camel они должны выглядеть следующим образом: id и ok.
Использование регистров в акронимах зависит от длины акронима. Все акронимы состоят минимум из двух символов. В рамках данного руководства если акроним состоит ровно из двух символов, он считается коротким акронимом. Акроним из трех и более символов является длинным акронимом.
В следующих правилах описывается использование регистров в коротких и длинных акронимах. Правила использования регистров в идентификаторах превалируют над правилами использования регистров в акронимах.
В коротких акронимах оба символа рекомендуется делать прописными, за исключением первого слова идентификатора в стиле Camel.
Свойство с именем DBRate является примером использования короткого акронима (DB) в качестве первого слова идентификатора в стиле Pascal. Параметр с именем ioChannel является примером использования короткого акронима (IO) в качестве первого слова идентификатора в стиле Camel.
В длинных акронимах рекомендуется делать прописным только первый символ, за исключением первого слова идентификатора в стиле Camel.
Класс с именем XmlWriter является примером использования длинного акронима в качестве первого слова идентификатора в стиле Pascal. Параметр с именем htmlReader является примером использования длинного акронима в качестве первого слова идентификатора в стиле Camel.
В любых акронимах (независимо от их длины) не рекомендуется делать прописными символы в начале идентификатора в стиле Camel.
Параметр с именем xmlStream является примером использования длинного акронима (xml) в качестве первого слова идентификатора в стиле Camel. Параметр с именем dbServerName является примером использования короткого акронима (db) в качестве первого слова идентификатора в "верблюжьем" стиле.
Правила использования прописных букв в сложных словах и общих терминах
Не начинайте с прописной буквы каждую часть так называемого единого сложного слова. Это сложные слова, которые пишутся слитно, например "endpoint".
Например, слово hashtable является единым сложным словом, которое следует рассматривать, как единое слово, и использовать регистры соответствующим образом. В стиле Pascal это выглядит так: Hashtable; в стиле Camel иначе: hashtable. Для того чтобы определить, является ли слово единым сложным словом, следует обратиться к словарю.
В приведенном ниже списке указаны некоторые общие термины, не являющиеся едиными сложными словами. Слово приведено сначала в стиле Pascal, затем в скобках — в стиле Camel.
BitFlag (bitFlag)
FileName (fileName)
LogOff (logOff)
LogOn (logOn)
SignIn (signIn)
SignOut (signOut)
UserName (userName)
WhiteSpace (whiteSpace)
Чувствительность к регистру
Правила использования прописных букв созданы исключительно для облегчения чтения и понимания. Они не могут использоваться в качестве средства предотвращения коллизий имен в библиотеках.
Не следует думать, что все языки программирования чувствительны к регистрам. Это не так. Имена не могут различаться только регистром.
Охраняется авторским правом Copyright 2005 Microsoft Corporation. Все права защищены.
Фрагменты — © Addison-Wesley Corporation. Все права защищены.
Для дополнительной информации о разработке руководящих принципов, смотрите "руководства по разработке рамок: Конвенций, идиомы и шаблоны для повторного использования.NET библиотек"книга, Кшиштоф Cwalina и Брэд Абрамс, опубликованных Addison-Wesley, 2005 года.