Поделиться через


Соглашения об именах Visual Basic

Обновлен: Ноябрь 2007

При присваивании имени элементу в приложении Visual Basic первым знаком имени должен быть алфавитный знак или подчеркивание. Однако обратите внимание, что имена, начинающиеся с символа подчеркивания, не совместимы с Спецификация CLS (CLS).

При присваивании имен необходимо учитывать следующие рекомендации.

  • Каждое отдельное слово в имени следует начинать с большой буквы, например, FindLastRecord или RedrawMyForm.

  • Первым словом в имени функции или метода следует ставить глагол, например InitNameArray or CloseDialog.

  • Имя класса, структуры, модуля и свойства рекомендуется начинать с существительного, например EmployeeName или CarAccessory.

  • Первым в имени интерфейса должен стоять префикс "I", вслед за которым идет имя существительное или именная группа, например IComponent, или имя прилагательное, описывающее поведение интерфейса, например IPersistable. Рекомендуется не использовать знаки подчеркивания и аббревиатуры, поскольку аббревиатуры могут ввести в заблуждение.

  • Имена обработчиков событий рекомендуется начинать с имени существительного, описывающего тип события, и дополнять его суффиксом "EventHandler", например "MouseEventHandler".

  • К именам аргументов классов событий следует добавлять суффикс EventArgs.

  • Если событие имеет смысл "до" или "после", следует использовать в его названии суффикс в настоящем или прошедшем времени, например "ControlAdd" или "ControlAdded".

  • Для длинных или часто используемых терминов допустимо применять аббревиатуры разумной длины, например "HTML" вместо "Hypertext Markup Language". В любом случае имена переменных длиной более 32 знаков плохо читаются на мониторе с небольшим разрешением. Также следует проверить, последовательно ли используются аббревиатуры на протяжении всего приложения. Попеременное использование в проекте "HTML" и "Hypertext Markup Language" может ввести в заблуждение.

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

См. также

Основные понятия

Ключевые слова как имена элементов в коде

Me, My, MyBase и MyClass в Visual Basic

Имена объявленных элементов

Другие ресурсы

Соглашения о структуре программы и коде

Справочник по Visual Basic