Комментарии Java

В этом курсе вы узнаете о Java комментариях, почему их используют и как правильно использовать комментарии.

В компьютерной программировании комментарии являются частью программы, Java компилятор полностью игнорирует комментарии. Они主要用于 помочь программистам лучше понимать код. Например,

// DECLARE И ИНИЦИАЛИЗИРУЙТЕ ДВЕ ПЕРЕМЕННЫЕ
int a = 1;
int b = 3;
// вывод
System.out.println("This is output");

Здесь мы используем следующие комментарии:

• DECLARE И ИНИЦИАЛИЗИРУЙТЕ ДВЕ ПЕРЕМЕННЫЕ

• вывод

Типы комментариев в Java

В Java есть два типа комментариев:

• однolinейный комментарий

• многострочные комментарии

однolinейный комментарий

Однolinейные комментарии начинаются и заканчиваются в одной строке. Чтобы написать однolinейный комментарий, можно использовать символы //. Например,

// "Hello, World!" Пример программы
　
class Main {
　　　　public static void main(String[] args) {}}　　　　	
　　　　{
　　　　　　　　// вывод "Hello, World!"
　　　　　　　　System.out.println("Hello, World!");
　　　　}
}

Вывод:

Hello, World!

Здесь мы используем два однolinейных комментария:

• "Hello, World!" Пример программы

• вывод "Hello World!"

Java компилятор игнорирует все содержимое от //конец строки до конца строки. Поэтому, его также называютконец строкикомментарий(однolinейный комментарий)。

многострочный комментарий

Когда мы хотим написать многострочный комментарий, мы можем использовать многострочный комментарий. Чтобы написать многострочный комментарий, мы можем использовать символы /*....*/. Например,

/* Это пример многострочного комментария.
　* Программа напечатает “Hello, World!” в стандартный вывод.
　*/
class HelloWorld {
　　　　public static void main(String[] args) {}}　　　　	
　　　　{	
　　　　　　　　System.out.println("Hello, World!");
　　　　}
}

Вывод:

Hello, World!

Здесь мы используем многострочный комментарий:

/* Это пример многострочного комментария.
　* Программа напечатает “Hello, World!” в стандартный вывод.
　*/

Этот тип комментариев также называетсяТрадиционные комментарииВ этом типе комментариев Java компилятор будет игнорировать все содержимое от /* до */.

Правильное использование комментариев

Вы всегда должны знать одно: комментарии не должны заменять объяснение плохого кода. Вы всегда должны писать структурированный и самообъясняющийся код. Только после этого можно рассмотреть возможность использования комментариев.

Некоторые люди считают, что код должен быть само�述ательным, и комментарии должны использоваться редко. Но с моей личной точки зрения, использование комментариев не является ошибкой. Мы можем использовать комментарии для объяснения сложных алгоритмов, регулярных выражений или решений, требующих выбора одного из нескольких методов для решения проблемы в различных технологиях.

ВниманиеВ большинстве случаев, пожалуйста, всегда используйте комментарии для объяснения “ Почему? ”вместо “ Как это сделать? 。