Съдържание:

Къде да сложа Javadoc коментари?
Къде да сложа Javadoc коментари?

Видео: Къде да сложа Javadoc коментари?

Видео: Къде да сложа Javadoc коментари?
Видео: Jah Khalib – Доча | ПРЕМЬЕРА ТРЕКА 2024, Ноември
Anonim

В javadoc помощната програма ви позволява слагам Вашият коментари точно до вашия код, във вашия ". java " изходни файлове. Когато сте доволни от вашия код и коментари , просто стартирате javadoc команда и вашия HTML стил документация се създава автоматично за вас.

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

Имайте предвид следното, когато използвате Добавете коментар на Javadoc (Alt+Shift+J): До добавете а коментар към поле, позиционирайте курсора върху декларацията на полето. Да се добавете а коментар към метод, позиционирайте курсора някъде в метода или в неговата декларация.

каква е ползата от коментарите на Javadoc? Javadoc е инструмент, който идва с JDK и е използван за генериране Java кодова документация в HTML формат от Java изходен код, който изисква документация в предварително дефиниран формат. Следва прост пример, където редовете вътре в /*…. */ са Java многоредов коментари.

Ето защо, къде да сложа Javadoc?

Можете да поставите JavaDoc коментари на всяко от трите различни места в изходния файл:

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

Как да пиша Javadoc коментари в Intellij?

3 отговора. Въведете /** + и след това натиснете Enter над подпис на метод ще създадете Javadoc мъничета за вас. Можеш използване действието „Коригиране на док коментар '. Той няма пряк път по подразбиране, но можете да му присвоите прекия път Alt + Shift + J в Keymap, защото този пряк път не се използва за нищо друго.

Препоръчано: