Java — оформление кода

Java — оформление кода.

Когда я только начинал программировать, я думал, что программа должна выполнять требуемые задачи и больше ничего не надо. Программа работает, выдает нужный код. Все отлично. Клиент рад. В дальнейшем как оказалось, что программирование — это не только придумать алгоритм и набрать его в компьютере, в программе нужно было создавать архитектуру, проектировать, учитывать возможность расширять программу, тестировать, проверять, анализировать связанности кода и банально оформлять код в одинаковом стиле. Одной из первых программ, которой я гордился была игра крестики нолики написанная на QBasic в графики на спреях. Делал я ее в 10 классе. Помню весь код у меня бы в одном большой цикл с мега условием на 200 строк. Условие проверяло шаги. Еще тогда я столкнулся с проблемой поиска ошибок в таком коде. Проверяя каждую строчку и перезапуская программу, можно было потратить целый день, чтобы найти неправильное условие или некорректные данные. Когда я пришел на свою первую работу, я ощутил эти принципы более жестче. Проект, в который я попал, уже был написан и мне нужно было править ошибки в логики и дописывать новый функционал. Одной из первых задач в проекте мне поручили добавить возможность импорта данных из системы active directory. Я быстро нашел нужный код. Это оказался класс на 4000 строк. Среда разработки периодически задумывалась, когда прокручивал ползунок для того чтобы найти нужный код. Мой коллега шутил по этому поводу, чтобы я развернул монитор, чтобы по вертикале было больше строк.

Ниже перечислены самые частые ошибки в коде, которые нужно избегать. Возьмите за правило. Прежде чем заливать код в репозиторий, проверьте каждый пункт из этого списка на своем коде.

1. Осмысленные названия для классов, методов, переменных.

В языке есть соглашения об оформлении кода.

— Имена классов начинаться с заглавной буквы.

— Имена методов и переменных со строчной.

1. Порядок объявления
2. Статические поля
3. Не статические поля
4. Конструкторы
5. Публичные статические методы
6. Приватные статические методы
7. Публичные не статические методы
8. Приватные не статические методы

В дополнении к этим пунктам хочу еще добавить несколько условий. Имена классов и переменных должны нести осмысленное название.

— Не стоит объявлять их виде одной буквы. Например, а1, а2.
— Не стоит в переменных использовать типы данных, которые хранят переменные. Например, valueInteger, managerService.
— Стараться использовать одно слова для переменной.

В заключение можно сказать: если проект для вашего бизнеса нужен уже сейчас, и нет ни времени, ни сил на приобретения навыков — стоит прибегнуть к услуге по разработке сайтов, доверив всю или часть работы опытным специалистам со стажем.

Добавить комментарий

Ваш e-mail не будет опубликован. Обязательные поля помечены *