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

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


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

  1. Код должен быть отформатирован. Выделяем (Ctrl+A), форматируем (Ctrl+Alt+L).
  2. Классы должны быть в пакетах.
  3. Код может содержать только документирующие комментарии.
    /**
     * Эта программа делает то-то и то-то
     */​
  4. Код НЕ должен содержать ненужный импорт пакетов.
  5. Код НЕ должен содержать избыточные пустые строки.
  6. Имена идентификаторов должны соответствовать рекомендациям по именованию.

 

После изучения модификаторов доступа:

  1. Переменные класса рекомендуется делать private.
  2. Доступ к переменным класса осуществляется через геттеры и сеттеры. 
  3. Методы и конструкторы должны быть с модификаторами доступа.
  4. В классе рекомендуется сначала объявляются статические переменные, переменные класса, потом конструкторы, геттеры, сеттеры. Потом все остальные методы.

 

После изучения final переменных:

  1. Вместо магических чисел используем константы.

 

После изучения класса Object:

  1. Желательно переопределять в создаваемом классе методы toString, equals и hashCode.

 



0 comments
Leave your comment: