В языке существует удобный механизм документирования кода. Называется он JavaDoc. В коде нужно избегать использовать комментарии. Так как это свидетельство усложненной логики. Лучше, если вы более детально сделаете описание JavaDoc.
JavaDoc — это особый комментарий в коде, который располагается перед именем класса, метода, конструктора переменной.
Комментарий должен описывать поведение данного метода. Так же желательно описать его работу. Это поможет Вам понять на сколько правильно вы составили поведение данного класса, метода и переменной и стоит ли провести рефакторинг данного кода.
В комментарии так же можно использовать теги. В дальнейшем эти теги будут конвертироваться в html код
@param name — description — Описывает входящий параметр.
@return name — description — описывает возвращаемый тип.
@throws — описывает возможные исключения, которые может кинуть код. @author — имя и фамилия автора данного кода @since — дата создания @version — версия файла.
К слову, если вы решили вплотную заняться программированием, и подолгу засиживаться за компом — крайне важно подобрать годный монитор: тут тут вы сможете выбрать подходящий вариант, а также получить рождественскую скидку!
Писать тесты на весь код
Когда начинающий программист слышит слово тест, он думает, что это должны делать тестеры, а он же программист и таким не занимается. Другая плохая мысль, когда программист думает про тест, только со стороны инструмента для поиска ошибок в коде. С начало стоит разобраться, что такое тест и какие тесты должен делать программист и зачем.
Тест — это последовательность действий, направленных на выполнения конкретной функции в программе, по окончанию которых получается результат, который человек на основании своих ожиданий может проверить. Программист должен использовать автоматические тесты. В данном курсе используется библиотека Junit для написания тестов. Существуют два типа тестирования автоматическое и ручное. Целью автоматического тестирования является снижения риска возникновения ошибок в коде в уже реализованном коде, а так проверка качества кода. Каким образом тесты проверяют качество кода?! Если на код нельзя написать тест, значит программа написана без возможности расширения, а значит любые изменения в требованиях заказчика повлекут к изменению уже существующего кода и появлению новых ошибок. Так же такой код будет горазда сложнее поддерживать.
Как правильно писать тесты. Существуют четкий и достаточно простой принцип. Он носит названия трех А.
А — Assign — блок для создания и инициализации входящих, ожидаемых и проверяемых данных.
A — Act — блок выполнения действий.
А — Assert — блок проверки ожидаемых данных и полученных.
Добавить комментарий