Написание качественных программ не обходится без комментирование кода . Комментирование кода - это полезная привычка с помощью которой можно убить сразу двух зайцев:
Написание качественных программ не обходится без комментирование кода. Комментирование кода - это полезная привычка с помощью которой можно убить сразу двух зайцев:
- комментируя код Вы в последствии сможете быстро понять о чем идет речь, когда вернетесь к коду через некоторое время
- грамотные и понятные комментарии можно сразу оформлять в стиле javadoc. Затем по всем классам проекта можно автоматически сформировать документацию, если появится потребность выставить код на всеобщее обозрение. Таким образом, не придется тратить время на написание документации к проекту.
В Java, как и в PHP присутствует несколько видов комментариев, каждый из которых может быть полезен в определенных случаях.
Итак, рассмотрим простейшую программу на Java, которая содержит комментарии:
/**
* Данный комментарий описывает класс MyrusakovApp
* текст комментария может располагаться на нескольких строках
*/
class MyrusakovApp {
/**
* Главный метод
*
* @return void - один из специальных маркер в javadoc для обозначения возвращаемого значения
*/
public static void main(String[] args) {
System.out.println("Author: Myrusakov!"); // Однострочный комментарий - Отображает строку.
}
}
В Java существуют следующие виды комментариев:
/* простой текст. все что внутри игнорируется компилятором */
/**
* комментарий документации
*
* с помощью него создается комментарий документирования. Компилятор игнорирует все что находится внутри данного комментария
* Утилита javadoc использует этот тип комментариев для автогенерации документации. Необходимые параметры задаются с помощью
* специальных терминов
*
*/
// Просто однострочный комментарий, который распространяется до конца строки
Таким образом, комментарии - это очень важный и нужный инструмент, для использования которого надо просто выработать привычку, которая даст свои плоды в будущем.
