Java-комментарии

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

В этом руководстве вы узнаете о комментариях 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!

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

• "Привет, мир!" пример программы
• выводит "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!");
    }
}

Вывод :

Hello, World!

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

/* This is an example of multi-line comment.
* The program prints "Hello, World!" to the standard output.
*/

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

<час>

Используйте комментарии правильно

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

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

Примечание :в большинстве случаев всегда используйте комментарии, чтобы объяснить «почему ', а не 'как ' и вы можете идти.