Правила именования методов семейства API - PullRequest
Новая
       14

Правила именования методов семейства API

0 голосов
/ 21 ноября 2018

Вы бы назвали семейство методов API (более легко найти для программистов)

  • Rectangle
  • RectangleRounded
  • RectangleInflated

или (удобнее читать на беглом английском)

  • Прямоугольник
  • RoundedRectangle
  • InflatedRectangle

?

Где найти обсуждение плюсов и минусов по этой теме?

Спасибо.

Ответы [ 2 ]

0 голосов
/ 21 ноября 2018

Microsoft рекомендует (и использует в .NET Framework) форму: RoundedRectangle.

MS предоставляет очень полезный документ по именованию документ.В Имена классов, структур и интерфейсов chapter можно найти следующее:

РАССМОТРЕТЬ, заканчивая имя производных классов именем базового класса.

0 голосов
/ 21 ноября 2018

Трудно найти что-то, что конкретно говорит о вашей конкретной теме, но я нашел это, которое просто отвечает на ваш вопрос:

  • ThingAbstract: суффикс "Abstract".Неестественный язык.Появляется рядом с ThingInterface в списках файлов.
  • AbstractThing: префикс «Abstract».Естественный язык.Вдали от ThingInterface в списках файлов.

Источник: https://www.drupal.org/project/coding_standards/issues/1567920

Помимо упоминания естественности, в нем говорится о порядке листинга, который может помочь понять структуру проекта (все жесткие подпапки должны компенсировать это)Специализация [..]

Источник: Соглашения об именах пространства имен C # и классов / подклассов, когда верхнее пространство имен содержит базовый класс, а внутренние пространства имен содержат подклассы

Я думаю, это в основном основано на мнениях, и лично я предпочел бы второй способ (RoundedRectangle), так как он более естественен для чтения и, следовательно, для понимания.Также я думаю (и, как я часто читаю онлайн), мы должны постараться сделать имена классов как можно более значимыми.

...