Имена членов типа
Типы содержат члены следующих видов:
Методы
Свойства
Поля
События
Рекомендации данного раздела помогут разработчикам библиотек классов выбрать имена для членов, согласующиеся с библиотекой .NET Framework.
Имена методов
Для имен методов следует использовать глаголы или глагольные фразы.
Обычно методы работают с данными, поэтому использование глагола для описания действия метода упрощает понимание разработчиками сути метода. При определении действия метода выбирайте имена, которые вносят ясность с точки зрения разработчика. Не выбирайте глаголы, которые описывают, каким образом метод выполняет свою функцию; другими словами, не используйте в имени метода детали реализации.
Имена свойств
В именах свойств используйте существительные, фразы на основе существительных или прилагательные.
Фразы на основе существительных и прилагательные предпочтительны для свойств, так как свойства содержат данные.
Не используйте имена свойств, совпадающие с именами методов Get.
Например, не называйте одновременно свойство EmployeeRecord, а метод — GetEmployeeRecord. Разработчики не смогут понять, какой член использовать для выполнения задачи программирования.
В именах логических свойств используйте утвердительную фразу (CanSeek вместо CantSeek). К именам логических свойств можно дополнительно прибавлять префикс Is, Can или Has, но только тогда, когда он действительно необходим.
Рекомендуется присваивать свойству то же имя, что и у его базового типа.
При наличии свойства со строго определенным типом перечисления имя свойства может совпадать с именем перечисления. Например, если перечисление имеет имя CacheLevel, свойство, возвращающее одно из его значений, также может быть названо CacheLevel.
Имена событий
В именах событий используйте глаголы или фразы на основе глаголов.
Обозначайте прошлое и будущее в именах событий, используя прошедшее и будущее времена. Например, событие закрывания, генерируемое перед закрытием окна, будет называться "Closing", а то, которое генерируется после закрытия окна, будет называться "Closed".
Для обозначения предыдущих или последующих событий не используйте префиксы и суффиксы "Before" и "After".
В именах обработчиков событий (делегатов, используемых как типы событий) используйте суффикс "EventHandler".
В сигнатурах обработчиков событий используйте два параметра с именами "sender" и "e".
Параметр sender должен иметь тип Object, а параметр e должен быть экземпляром или производным классом класса EventArgs.
В именах классов аргументов событий должен присутствовать суффикс "EventArgs".
Имена полей
Рекомендации по присвоению имен полям относятся к статическим открытым и защищенным полям. Не следует определять открытые или защищенные экземпляры полей. Дополнительные сведения см. в разделе Разработка полей.
Применяйте в именах полей правила использования прописных и строчных букв языка Pascal.
Используйте в именах полей существительные или фразы на основе существительных.
Не используйте в именах полей префиксы. Например, не используйте "g_" или "s_" для разделения статических и нестатических полей.
Фрагменты — © Корпорация Майкрософт (Microsoft Corp.), 2005. Все права защищены.
Фрагменты — © Addison-Wesley Corporation. Все права защищены.
Для дополнительной информации о разработке руководящих принципов, смотрите "руководства по разработке рамок: Конвенций, идиомы и шаблоны для повторного использования.NET библиотек"книга, Кшиштоф Cwalina и Брэд Абрамс, опубликованных Addison-Wesley, 2005 года.