Мазмуну:

Javadoc комментарийлерин кайда коём?
Javadoc комментарийлерин кайда коём?

Video: Javadoc комментарийлерин кайда коём?

Video: Javadoc комментарийлерин кайда коём?
Video: Чистый код 2024, Ноябрь
Anonim

The javadoc утилита сизге мүмкүнчүлүк берет кой сенин комментарийлер кодуңуздун жанында, сиздин ". java " булак файлдары. Кодуңузга канааттанганыңызда жана комментарийлер , сиз жөн гана иштетесиз javadoc буйрук жана сиздин HTML стилиңиз документтер сиз үчүн автоматтык түрдө түзүлөт.

Анан кантип Javadocка комментарийлерди кошо аласыз?

Колдонууда төмөнкүлөрдү эске алыңыз Javadoc комментарий кошуу (Alt+Shift+J): То кошуу а комментарий талаага, курсорду талаа декларациясына жайгаштырыңыз. үчүн кошуу а комментарий методго, курсорду методдун же анын декларациясынын каалаган жерине жайгаштырыңыз.

Javadoc комментарийлеринин кандай пайдасы бар? Javadoc JDK менен келген курал жана ошондой колдонулган түзүү үчүн Java HTML форматындагы коддук документтер Java алдын ала аныкталган форматта документтерди талап кылган баштапкы код. Төмөндө /*… ичиндеги сызыктар жөнөкөй мисал келтирилген. */ болуп саналат Java көп линиялуу комментарийлер.

Мен Javadocту кайда коем?

Сиз JavaDoc комментарийлерин баштапкы файлдагы үч башка жердин каалаганына жайгаштырсаңыз болот:

  1. Коомдук класс жарыялоонун алдында дароо.
  2. Коомдук талааны жарыялоонун алдында дароо.
  3. Коомдук ыкма же конструктор жарыялоонун алдында дароо.

Intellijде Javadoc комментарийлерин кантип жазам?

3 Жооптор. /** + терип, андан кийин ыкманын үстүндөгү Enter баскычын бассаңыз, кол тамга түзүлөт Javadoc сен үчүн. Сенин колуңдан келет колдонуу аракети 'Fix doc комментарий '. Анын демейки жарлыгы жок, бирок сиз ага Ачкыч картасында Alt + Shift + J жарлыгын дайындай аласыз, анткени бул жарлык башка эч нерсе үчүн колдонулбайт.

Сунушталууда: