Конвенції про кодування - називання перерахунків

Чи існує угода про іменування перерахувань на Java?

Моя перевага полягає в тому, що перерахунок - це тип. Так, наприклад, у вас є перерахунок

Fruit{Apple,Orange,Banana,Pear, ... }

NetworkConnectionType{LAN,Data_3g,Data_4g, ... }

Я проти називати це:

FruitEnum
NetworkConnectionTypeEnum

Я розумію, легко вибрати, які файли є перерахунками, але тоді у вас також буде:

NetworkConnectionClass
FruitClass

Також, чи є хороший документ, що описує те саме для констант, де їх декларувати тощо?

Енуми - це заняття і повинні дотримуватися конвенцій про класи. Примірники перерахунку є константами і повинні дотримуватися конвенцій про константи. Так

enum Fruit {APPLE, ORANGE, BANANA, PEAR};

Немає жодної причини писати FruitEnum більше, ніж FruitClass. Ви просто витрачаєте чотири (або п’ять) символів, які не додають інформації.

Сама Java рекомендує такий підхід, і він використовується в їх прикладах .

Це, мабуть, не зробить мені багато нових друзів, але слід додати, що люди з C # мають інший настанов: Екземпляри перерахунків - це "справа Паскаля" (верхній / нижній регістр змішаний). Див. Дискусію щодо stackoverflow та вказівки щодо іменування типу переліку MSDN .

Оскільки ми обмінюємось інформацією із системою C #, я спокусився точно скопіювати їх перерахунки, ігноруючи конвенцію Java про «константи мають великі імена». Думаючи про це, я не бачу великої цінності в тому, щоб обмежитися великими літерами для екземплярів. Для деяких цілей .name () - це зручний ярлик для отримання читабельного зображення константи enum, а змішане ім'я регістру виглядатиме приємніше.

Отже, так, я наважуюся поставити під сумнів значення конвенції про іменування Java enum. Той факт, що "інша половина світу програмування" дійсно використовує інший стиль, змушує мене думати, що законно сумніватися у нашій власній релігії.

Як уже зазначалося, екземпляри enum мають бути великими літерами відповідно до документів на веб-сайті Oracle ( http://docs.oracle.com/javase/tutorial/java/javaOO/enum.html ).

Однак, переглядаючи навчальний посібник JavaEE7 на веб-сайті Oracle ( http://www.oracle.com/technetwork/java/javaee/downloads/index.html ), я натрапив на навчальний посібник «Книжковий магазин Дюка» та в класі ( tutorial\examples\case-studies\dukes-bookstore\src\main\java\javaeetutorial\dukesbookstore\components\AreaComponent.java), Я знайшов таке визначення enum:

private enum PropertyKeys {
    alt, coords, shape, targetImage;
}

Згідно з умовами, воно повинно виглядати так:

public enum PropertyKeys {
    ALT("alt"), COORDS("coords"), SHAPE("shape"), TARGET_IMAGE("targetImage");

    private final String val;

    private PropertyKeys(String val) {
        this.val = val;
    }

    @Override
    public String toString() {
        return val;
    }
}

Так здається, навіть хлопці з Oracle іноді торгують з'їздом із зручністю.

У нашій кодовій базі; ми, як правило, оголошуємо переліків у класі, до якого вони належать.

Отже, для вашого прикладу Fruit, у нас був би клас Fruit, а всередині - Enum під назвою Fruits.

Посилання на нього у коді виглядає приблизно так: Fruit.Fruits.Apple, Fruit.Fruits.Pearтощо.

Константи слідують за тим самим рядком, де вони або визначаються в класі, до якого вони відповідають (так щось подібне Fruit.ORANGE_BUSHEL_SIZE); або якщо вони застосовують загальносистемні (тобто еквівалентні "нульові значення" для ints) у класі, названому "ConstantManager" (або еквівалент; подібний ConstantManager.NULL_INT). (бічна примітка; всі наші константи знаходяться у верхньому регістрі)

Як завжди, ваші стандарти кодування, ймовірно, відрізняються від моїх; так YMMV.

Вони все ще є типами, тому я завжди використовую ті самі умови іменування, які я використовую для класів.

Я, безумовно, нахмурився б, щоб ввести ім’я "Class" або "Enum". Якщо у вас є і a, FruitClassі FruitEnumтоді щось інше не так, і вам потрібні більш описові назви. Я намагаюся думати про тип коду, який би призвів до необхідності обох, і, здається, повинен бути Fruitбазовий клас із підтипами замість enum. (Це лише мої власні домисли, хоча у вас може виникнути інша ситуація, ніж те, що я уявляю.)

Найкраща посилання, яку я можу знайти для іменування констант, походить з підручника « Змінні» :

Якщо вибране ім’я складається лише з одного слова, напишіть це слово всіма малими літерами. Якщо воно складається з декількох слів, з великої літери напишіть кожне наступне слово. Назви gearRatio та currentGear - основні приклади цієї конвенції. Якщо ваша змінна зберігає постійне значення, наприклад, статичний кінцевий int NUM_GEARS = 6, умовна умова змінюється незначно, використовуючи великі літери і відокремлюючи наступні слова символом підкреслення. За умовою, символ підкреслення ніколи не використовується в іншому місці.

Якщо я можу додати 0,02 долара, я вважаю за краще використовувати PascalCase як значення перерахунків у С.

В C вони в основному глобальні, і PEER_CONNECTED стає дійсно стомлюючим на відміну від PeerConnected.

Подих свіжого повітря.

Буквально це змушує мене дихати легше.

У Java можна використовувати нераціональні імена enum, поки ти статично імпортуєш їх з іншого класу.

import static pkg.EnumClass.*;

Тепер ви можете використовувати некваліфіковані імена, які ви вже кваліфікували по-іншому.

Наразі я (думаю) про перенесення деякого коду С на Java і наразі 'розірваний' між вибором Java-конвенції (яка є більш багатослівною, більш тривалою та потворною) та моїм стилем C.

PeerConnected стане PeerState.CONNECTED, за винятком операторів перемикання, де це З'єднано.

Зараз для останньої конвенції можна сказати багато, і це виглядає приємно, але певні "ідіоматичні фрази", такі як if (s == PeerAvailable)стати подібними if (s == PeerState.AVAILABLE)та ностальгічно, для мене це втрата сенсу.

Я думаю, що я все ще віддаю перевагу стилю Java через ясність, але мені важко дивитися на кричущий код.

Тепер я розумію, що PascalCase вже широко використовується на Java, але дуже заплутаною ситуацією насправді цього не було б, просто невдало.

enum MyEnum {VALUE_1,VALUE_2}

(приблизно) як сказати

class MyEnum {

    public static final MyEnum VALUE_1 = new MyEnum("VALUE_1");
    public static final MyEnum VALUE_2 = new MyEnum("VALUE_2");

    private final name;

    private MyEnum(String name) {
        this.name = name;
    }

    public String name() { return this.name }
}

тож я здогадуюсь, що всі літери суворо правильніші, але все ж я використовую умову назви класу, оскільки я ненавиджу всі шапки куди завгодно