Рекомендации по оформлению кода

Перед коммитом кода (отправки домашнего задания на проверку) проверьте, выполнили ли вы следующие пункты:

  1. Код должен быть отформатирован. (Ctrl+Alt+L).
  2. Классы должны быть в пакетах.
  3. Код может содержать только документирующие комментарии.
    /**
     * Эта программа делает то-то и то-то
     */​
  4. Код НЕ должен содержать ненужный импорт пакетов.
  5. Код НЕ должен содержать избыточные пустые строки.
  6. Имена идентификаторов должны соответствовать рекомендациям по именованию.
  7. Переменные класса рекомендуется делать private.
  8. Доступ к переменным класса осуществляется через геттеры и сеттеры. 
  9. Методы и конструкторы должны быть с модификаторами доступа. Если метод используется только другими методами этого класса, следует объявлять его как private.
  10. В классе рекомендуется сначала объявляются статические переменные, переменные класса, потом конструкторы, геттеры, сеттеры. Потом все остальные методы.
  11. Вместо магических чисел используем константы.
  12. Желательно переопределять в создаваемом классе методы toString, equals и hashCode.
Trustpilot
Comments