Оглавление:
Определение - Что означают комментарии?
Комментарии на Java объясняют действия определенного фрагмента кода. Они используются для предоставления сводки кода на простом английском языке, чтобы помочь будущим разработчикам лучше понять код.
Техопедия объясняет Комментарии
В Java существует пять типов комментариев: Блочные комментарии дают обзор файла или метода, а также могут использоваться внутри метода. Метод блочного комментария объявляется следующим образом: / * * блочный комментарий, описывающий обзор кода. * / Однострочные комментарии - это короткие комментарии, которые могут быть записаны в одну строку. Если однострочный комментарий не помещается в одной строке, следует использовать блочный комментарий. Ниже приведен пример однострочного комментария: If (условный оператор) {/ * выполнение условного оператора * / …} / * является разделителем для однострочного комментария. Завершающие комментарии - это очень короткие комментарии, написанные в той же строке кода, которая описывается. Разделителями являются / *… * /. Комментарии в конце строки записываются в конце строки, а разделитель - //. Комментарии к документации, написанные до объявления, используются для объяснения интерфейсов, классов, конструкторов, методов и полей Java. Разделителями являются /**…*/. Это определение было написано в контексте Java