В этом руководстве вы узнаете о комментариях Java, почему мы их используем и как правильно использовать комментарии.
В компьютерном программировании комментарии - это часть программы, которая полностью игнорируется компиляторами Java. В основном они используются, чтобы помочь программистам понять код. Например,
// declare and initialize two variables int a =1; int b = 3; // print the output System.out.println("This is output");
Здесь мы использовали следующие комментарии:
- объявить и инициализировать две переменные
- распечатать вывод
Типы комментариев в Java
В Java есть два типа комментариев:
- однострочный комментарий
- многострочный комментарий
Однострочный комментарий
Однострочный комментарий начинается и заканчивается на одной строке. Чтобы написать однострочный комментарий, мы можем использовать //символ. Например,
// "Hello, World!" program example class Main ( public static void main(String() args) ( ( // prints "Hello, World!" System.out.println("Hello, World!"); ) )
Выход :
Привет мир!
Здесь мы использовали два однострочных комментария:
- "Привет мир!" пример программы
- печатает "Hello World!"
Компилятор Java игнорирует все, начиная //с конца строки. Следовательно, он также известен как комментарий конца строки .
Многострочный комментарий
Когда мы хотим писать комментарии в несколько строк, мы можем использовать многострочный комментарий. Чтобы писать многострочные комментарии, мы можем использовать символ / *…. * /. Например,
/* This is an example of multi-line comment. * The program prints "Hello, World!" to the standard output. */ class HelloWorld ( public static void main(String() args) ( ( System.out.println("Hello, World!"); ) )
Выход :
Привет мир!
Здесь мы использовали многострочный комментарий:
/* This is an example of multi-line comment. * The program prints "Hello, World!" to the standard output. */
Этот тип комментария также известен как традиционный комментарий . В комментариях этого типа компилятор Java игнорирует все, от /*до */.
Используйте комментарии правильно
Вы всегда должны учитывать одну вещь: комментарии не должны заменять способ объяснить плохо написанный код на английском языке. Вы всегда должны писать хорошо структурированный и самоочевидный код. А затем используйте комментарии.
Некоторые считают, что код должен быть самоописывающимся, а комментарии должны использоваться редко. Однако, на мой взгляд, в комментариях нет ничего плохого. Мы можем использовать комментарии для объяснения сложных алгоритмов, регулярных выражений или сценариев, в которых нам нужно выбрать один метод из разных методов для решения проблем.
Примечание . В большинстве случаев всегда используйте комментарии, чтобы объяснить « почему », а не « как », и все готово.
