Java Соглашение об именовании типа Enum - PullRequest
0 голосов
/ 01 мая 2020

Какова наилучшая практика именования enum

public enum SystemTypeEnum {

    RRD, FFR, DDE
}

В настоящее время имя SystemTypeEnum. Это нормально, или у нас должно быть имя как SystemType

Хотелось бы узнать лучшие практики.

Ответы [ 2 ]

1 голос
/ 01 мая 2020

Отказ от ответственности: я понимаю, что мой ответ можно считать самоуверенным, поэтому мой ответ отражает мой собственный опыт.

Я думаю, что лучше переименовать в SystemType Понятно, что его перечисление, все современные IDE показывают, что , Следуя этой логике c, если у вас есть, например, интерфейс

interface Calculator {
   int plus(int a, int b);
   int minus(int a, int b);
}

Он должен быть переименован в CalculatorInterface - звучит странно, верно?

Другой пример:

class Person {
   String name;
   int age;
}

Считаете ли вы хорошей идеей переименовать его в PersonClass только из-за его класса?

Итог, как я уже сказал, вы можете положиться на IDE здесь - он обеспечит визуальный намек на то, что это такое.

0 голосов
/ 01 мая 2020

Результат

Это топи, основанные на мнениях c, поэтому я постараюсь сохранить объективность.

Существуют различных стандартов и мнений и нет очень четкого исхода для обсуждения.

Насколько мне известно, наиболее часто используемый используемый стиль состоит в том, чтобы не имел суффикса или префикса .


Аргументы

Обсуждение обычно также включает пре- или суффиксы для abstract классов и interface с, а не только enum с. Также часто встречаются префиксы, такие как E, A, I вместо суффикса.

Некоторые утверждают, что оно не добавляет никакой полезной дополнительной информации к имени и только загромождает его. Некоторые говорят, что это не должно иметь значения, будь то, скажем, интерфейс или класс. Некоторые говорят, что это работа IDE, а не имя для указания типа, например, с помощью цветов и значков. Но есть и мнения в пользу этого стандарта имен.


Рекомендации по стилю

Широко распространенное руководство по стилю: Стиль Googles , цитата:

В Google Style специальные префиксы или суффиксы не используются. Например, эти имена не являются Google Style: name_, mName, s_name и kName.

Другой стиль, который обычно упоминается, - это стиль, используемый в JDK Java сами разработчики, они также не используют префикс или суффикс.

Но, опять же, это только некоторые стили, есть и другие.

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...