Рекомендации по оформлению кода
Перед коммитом кода (отправки домашнего задания на проверку) проверьте, выполнили ли вы следующие пункты:
- Код должен быть отформатирован. (Ctrl+Alt+L).
- Классы должны быть в пакетах.
- Код может содержать только документирующие комментарии.
/** * Эта программа делает то-то и то-то */
- Код НЕ должен содержать ненужный импорт пакетов.
- Код НЕ должен содержать избыточные пустые строки.
- Имена идентификаторов должны соответствовать рекомендациям по именованию.
- Переменные класса рекомендуется делать private.
- Доступ к переменным класса осуществляется через геттеры и сеттеры.
- Методы и конструкторы должны быть с модификаторами доступа. Если метод используется только другими методами этого класса, следует объявлять его как private.
- В классе рекомендуется сначала объявляются статические переменные, переменные класса, потом конструкторы, геттеры, сеттеры. Потом все остальные методы.
- Вместо магических чисел используем константы.
- Желательно переопределять в создаваемом классе методы toString, equals и hashCode.
Зарегистрируйтесь или войдите, чтобы иметь возможность оставить комментарий.