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

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

Когда вы создаете новый проект в NetBeans, обратите внимание, что некоторый текст выделен серым цветом с множеством косых черт и звездочек:

Проект Java

Выделенные области - это комментарии.

Когда программа запускается, комментарии в Java игнорируются. Таким образом, вы можете ввести все, что хотите внутри своих комментариев. Но обычно комментарии пишут для того, чтобы объяснить то, что написано в коде.

Как правильно писать комментарии в Java

Чтобы написать комментарий в одну строку, поставьте две косые черты, а затем свой комментарий:

// Это однострочный комментарий

Если вам необходимо более одной строки, вы можете сделать так:

// Этот комментарий распространяется
// на две или более строк

Или можете сделать так:

/*
Этот комментарий занимает две или более строк
*/

В приведенном выше комментарии обратите внимание, что он начинается с /*. Но чтобы закончить комментарий, нужно поменять местами */.

Кроме этого, на картинке сверху вы можете заметить то, что называется комментарием Javadoc.

Комментарий Javadoc начинается с одной косой черты и двух звездочек (/**) и заканчивается звездочкой и одной косой чертой (*/). Каждая строка комментария начинается с одной звездочки:

/**
* Это комментарий Javadoc
*/

Комментарии Javadoc используются для документирования кода.

Документированный код может быть превращен в HTML-страницу, которая будет полезна для других.

Вы можете увидеть, как она выглядит. В меню Run в верхней части NetBeans выберите Generate Javadoc. Однако сейчас вы увидите не так много, так как еще не написали код!

Generate Javadoc html

На этом этапе вашей карьеры программиста вы можете удалить комментарии, сгенерированные для вас NetBeans.

Вот наш новый код с удаленными комментариями:

Код Java без комментариев

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

Дата обновления: 10.07.2019

  • Текущий 0.00/5
  • 1
  • 2
  • 3
  • 4
  • 5

/Рейтинг: 0.0/5 (0 голос(ов) всего)

Добавить комментарий (без регистрации)