Оглавление:

Где я могу разместить комментарии Javadoc?
Где я могу разместить комментарии Javadoc?

Видео: Где я могу разместить комментарии Javadoc?

Видео: Где я могу разместить комментарии Javadoc?
Видео: Урок Java 154: Javadoc 2024, Декабрь
Anonim

В javadoc утилита позволяет вам положил ваш Комментарии прямо рядом с вашим кодом, внутри вашего ". Джава "исходные файлы. Когда вы довольны своим кодом и Комментарии , вы просто запускаете javadoc команда и ваш HTML-стиль документация автоматически создается для вас.

Тогда как добавить комментарии в Javadoc?

Помните следующее при использовании Добавить комментарий Javadoc (Alt + Shift + J): чтобы Добавить а комментарий к полю, поместите курсор на объявление поля. К Добавить а комментарий к методу, поместите курсор в любом месте метода или его объявления.

какая польза от комментариев Javadoc? Javadoc это инструмент, который поставляется с JDK, и это использовал для создания Джава документация по коду в формате HTML из Джава исходный код, для которого требуется документация в заранее определенном формате. Ниже приводится простой пример, в котором строки внутри / *…. */ находятся Джава многострочный Комментарии.

Поэтому куда мне поместить Javadoc?

Комментарии JavaDoc можно разместить в любом из трех разных мест исходного файла:

  1. Непосредственно перед объявлением публичного класса.
  2. Непосредственно перед объявлением публичного поля.
  3. Непосредственно перед объявлением общедоступного метода или конструктора.

Как мне писать комментарии Javadoc в Intellij?

3 ответа. Набрав / ** +, а затем нажав Enter над подписью метода, вы создадите Javadoc заглушки для вас. Вы можете использовать действие 'Исправить документ комментарий '. У него нет ярлыка по умолчанию, но вы можете назначить ему ярлык Alt + Shift + J в таблице клавиш, потому что этот ярлык не используется ни для чего другого.

Рекомендуемые: