Всем здравствуйте;) Продолжим наше совместное изучение Java. Начнем с того, что вспомним чему мы научились:
- Каждая программа на языке Java должна иметь класс;
- Каждая Java программа начинается с метода main;
- Параметры методов объявляются внутри скобок, которые следуют после имени метода;
- В классах, методах, и других структурах код всегда заключается в фигурные скобки { };
- Не используйте точки с запятыми после объявлений методов и классов, после которых следует определение тела с помощью фигурных скобок.
Комментарии в Java.
Перейдем к следующему разделу: "Комментарии".
Целью включения комментариев в ваш код является объяснение, что делает ваша программа. Добавление комментариев в код, является хорошей практикой. Так будет проще вам работать с вашим кодом и другим разработчикам разобраться в нём.
Java поддерживает и однострочные, и многострочные комментарии. Все символы, которые находятся внутри комментариев, игнорируются Java компилятором.
Однострочный комментарий начинается с двух косых черт (слэшей) и продолжается до окончания строки.
//Пример однострочного комментария
x = 5 ; // тут вы можете оставить комментарий о том, что происходит в коде
Многострочные Комментарии (Блочный)
Java также поддерживает комментарии, которые занимают несколько строк. Такой комментарий начинается с символа косой черты, за которым следует символ звездочки, и заканчивается символом звездочки, за которым следует символ косой черты.
/* This is also a
comment spanning
multiple lines */
Обратите внимание, что Java не поддерживает вложенные многострочные комментарии.
Однако, вы можете вложить однострочные комментарии внутри многострочных комментариев.
/* This is a single-line comment:
// a single-line comment
*/
Комментарии Документации
Комментарии документации это специальные комментарии, которые выглядят как многострочные комментарии, но отличаются тем, что они генерируют внешнюю документацию вашего исходного кода. Они начинаются с символа косой черты, за которым следует два символа звездочки, и заканчивается символом звездочки, за которым следует символ косой черты.
/** This is a documentation comment */
/** This is also a
documentation comment */
Javadoc это инструмент, который включен в JDK и используется для генерации документации Java кода в HTML формате из исходного Java кода, которому необходима документация в предопределенном формате.
Если комментарий документации начинается более чем с двух символов звездочки, то Javadoc предполагает, что вы хотели создать "блок" вокруг вашего комментария в исходном коде. Дополнительные символы звездочки просто игнорируются.
/**********************
This is the start of a method
***********************/
(Для документации будет сохранен только текст: "This is the start of a method".)
Всех благодарю за внимание и надеюсь на продолжение совместного изучения и поддержку👋😉