Convention
Конвенция - соглашение между программистами, для общей выгоды.
Наименование
- Пакеты - "lowercase" или "lower.case". Компании используют свое инвертированное имя Интернет-домена, чтобы
начать их имена пакета — пример: "com.example.mypackage".
- Классы и интерфейсы - существительное PascalCase.
- Методы - глагол camelCase
- Переменные - camelCase. Не начинаться с "_" или "$"
- Константы - 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"
Полезные комментарии
- Краткое описание класса или метода(6 строк комментария вместо 80 строк кода).
- Дается ссылка на реализуемый малоизвестный алгоритм или структуру данных (например — «используется
алгоритм — Корасик», ссылка на сайт).
- Поясняет, почему автор использует не тот подход, который читающий код скорее всего ожидает тут увидеть.
- Дан короткий ясный пример использования.