Меркушин Денис https://t.me/illitain
Этот проект - пример структуры проекта для выполнения домашнего задания в рамках Java школы 2022 года от КРОК. Основные моменты:
- В проекте должен быть readme.md-файл, в котором должна быть информация об авторе (имя, фамилия. Ник в телеграме по желанию)
- Структура проекта - согласно примеру. Код лежит в папке src в пакетах ru.croc, где уже находятся пакеты каждой из задач (taskN). То есть решение каждой задачи - в своем пакете.
- При написании кода не забывайте о правилах кодирования на Java! Основные моменты перечислю сам:
- Обращайте внимание на названия классов, атрибутов и методов, а также имена переменных. Все они должны быть информативны и понятны.
- По классам - название основных классов (с main-методом) должно соответствовать шаблону: TaskN, где N - номер задачи
- В одной строке не должно быть большое количество операторов. В идеале - один оператор на строку, последующие - переносите на новые.
- ИНФОРМАТИВНЫЕ комментарии (особенно если где-то неуверены, сами понимаете, что пишите запутанный код и/или из нескольких альтернатив реализации выбрали что-то конкретное - прям пишите что рассматривали, что выбрали и почему).
- Обращайте внимание на названия классов, атрибутов и методов, а также имена переменных. Все они должны быть информативны и понятны.
P.S. В интернете много информации о правилах кодирования на Java. В целом, первая ссылка гугла по большей части описывает неплохо, хотя я лично привык переносить длинные строки не в формате
int result = function1(longExpression1,
function2(longExpression2,
longExpression3));
А в формате:
int result = function1(
longExpression1,
function2(
longExpression2,
longExpression3
)
);