Convention

Конвенция - соглашение между программистами, для общей выгоды.

Наименование

  1. Пакеты - "lowercase" или "lower.case". Компании используют свое инвертированное имя Интернет-домена, чтобы начать их имена пакета — пример: "com.example.mypackage".
  2. Классы и интерфейсы - существительное PascalCase.
  3. Методы - глагол camelCase
  4. Переменные - camelCase. Не начинаться с "_" или "$"
  5. Константы - SCREAMING_SNAKE_CASE

Абсолютный и относительный пути

Разделители

Linux - /

Абсолютный

Linux - "/home/user/Download/src/main/java/testJava/Main.java"

Windows - "C:/trash/blah/blah"

Относительный(поиск от корневой директории проекта)

Linux - "./src/main/resources/application.properties"

Windows - "./src/main/resources/application.properties"

Относительный(поиск от директории файла который исполняется)

Linux - "/resources/application.properties"

Windows - "/resources/application.properties"

Полезные комментарии

  1. Краткое описание класса или метода(6 строк комментария вместо 80 строк кода).
  2. Дается ссылка на реализуемый малоизвестный алгоритм или структуру данных (например — «используется алгоритм — Корасик», ссылка на сайт).
  3. Поясняет, почему автор использует не тот подход, который читающий код скорее всего ожидает тут увидеть.
  4. Дан короткий ясный пример использования.