Перейти к контенту

Комментарии на Java: однострочные, многострочные, разница между / * * / и / ** * /

Комментарии на любом языке программирования помогают сделать исходный код читаемым, компилятор игнорирует эти комментарии.

Виды

Java поддерживает три типа комментариев —

 

  • Однострочные комментарии — С их помощью вы можете прокомментировать отдельные строки. Компилятор игнорирует все от // до конца строки.
  • Многострочные комментарии — Можете прокомментировать несколько строк. Компилятор игнорирует все от / * до * /.
  • Документационные комментарии — Инструмент Javadoc JDK использует этот вид при подготовке автоматически сгенерированной документации.

Следующий пример демонстрирует использование всех трех типов комментариев в Java.

/**
   * @author Tutorialspoint
*/ 
public class CommentsExample {
   /*
      Following is the main method here,
      We create a variable named num.
      And, print its value    
   * */
   public static void main(String args[]) {
      // Declaring a variable named num
      int num = 1;
      // Printing the value of the variable num
      System.out.println("value if the variable num: "+num);
   }
}

Итог

value if the variable num: 1

Однострочный комментарий в Java

Чтобы прокомментировать конкретную строку, просто поместите двойную косую черту (//) перед строкой, как показано ниже.

// Hello this line is commented

Пример

Следующий пример демонстрирует использование однострочных комментариев в Java —

public class CommentsExample {
   public static void main(String args[]) {
      //Declaring a variable named num
      int num = 1;
      //Printing the value of the variable num
      System.out.println("value if the variable num: "+num);
   }
}

Итог

value if the variable num: 1

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

Многострочные комментарии в Java начинаются с / * и заканчиваются * /. Вы можете комментировать несколько строк, просто поместив их между / * и * /.

/* Hello this is the way
  to write multi line comments in Java */

Пример

public class CommentsExample {
   /*
      Following is the main method here,
      We create a variable named num.
      And, print its value    
   * */
   public static void main(String args[]) {
      int num = 1;
      System.out.println("value if the variable num: "+num);
   }
}

Итог

value if the variable num: 1

Разница между / * * / и / ** * / комментариями в Java

Чтобы разобраться в разнице между / * * / и / ** * / комментариями в Java приведем примеры.

Многострочные комментарии (/ * * /) используются для комментариев в несколько строк в исходном коде.

Пример с / * * /

public class CommentsExample {
   /*
      Following is the main method here,
      We create a variable named num.
      And, print its value    
   * */
   public static void main(String args[]) {
      //Declaring a variable named num
      int num = 1;
      //Printing the value of the variable num
      System.out.println("value if the variable num: "+num);
   }
}

Итог с / * * /

value if the variable num: 1

Документационный комментарий (/ ** * /) используется для создания документации по исходному коду с помощью инструмента Javadoc.

Пример с / ** * /

/**
   * @author Tutorialspoint
*/ 
public class CommentsExample {
   public static void main(String args[]) {
      int num = 1;      
      System.out.println("value if the variable num: "+num);
   }
}

Итог с / ** * /

value if the variable num: 1

Вы можете сгенерировать Java документацию выше класса с помощью команды Javadoc, как —

C:\Sample>javadoc CommentsExample.java

Оцени статью

Средняя оценка / 5. Количество голосов:

Спасибо, помогите другим - напишите комментарий, добавьте информации к статье.

Или поделись статьей

Видим, что вы не нашли ответ на свой вопрос.

Помогите улучшить статью.

 

Пока нет комментариев.

Добавить комментарий

Ваш e-mail не будет опубликован.

СайдбарКомментарии (0)