Javadoc dastur hujjatlashtirish vositasi

Javadoc
Скриншот программы Javadoc
Turi Hujjatlar generatori
Ishlab chiquvchi Sun Microsystems
Operatsion tizim turli platformalarda ishlaydi
Apparat platformasi Java virtual mashinasi (Java Virtual Machine)
So‘nggi versiya 1.50
Litsenziya GNU GPL 2 + «Classpath istisnosi» (Classpath exception)
Veb-sayt docs.oracle.com/javase/8…

Javadoc — hujjatlar generatori bo‘lib, HTML formatidagi hujjatlarni Java dastlabki kodidagi izohlardan yaratadi; uni Sun Microsystems ishlab chiqqan. Javadoc — klasslarni hujjatlashtirish uchun Java tilida qo‘llanadigan standart. Ko‘pgina dasturiy ta’minot ishlab chiqish muhitlari Javadoc yordamida avtomatik ravishda HTML hujjatlarni yaratadi.

Javadoc, shuningdek, API orqali dokletlar (doclets) va tegletlar (taglets) yaratish imkonini beradi. Ular dasturchiga Java ilovasi tuzilishini tahlil qilishga yordam beradi.


Qo‘llanilishi

Hujjatlashtirish izohlari quyidagi elementlarni hujjatlashtirish uchun qo‘llanadi:

  • klasslar,
  • interfeyslar,
  • maydonlar (o‘zgaruvchilar),
  • konstruktorlar,
  • metodlar,
  • paketlar.

Har bir holatda izoh hujjatlashtirilayotgan elementdan oldin joylashishi kerak.

Deskriptorlar ro‘yxati — Javadoc
DeskriptorTavsifQo‘llanadigan elementlar
@authorMuallifklass, interfeys
@versionVersiya. Har bir klassda bunday deskriptor bittadan ortiq bo‘lmasligi kerakklass, interfeys
@sinceQaysi versiyadan boshlab mavjudligini ko‘rsatadiklass, interfeys, maydon, metod
@seeHujjatlarning boshqa joyiga havolaklass, interfeys, maydon, metod
@paramMetodning kirish parametrimetod
@returnQaytariladigan qiymatning tavsifimetod
@exception имякласса описание
@throws имякласса описание
Metod yuzaga keltirishi mumkin bo‘lgan istisno holat tavsifimetod
@deprecatedEskirgan kod bloklarining tavsifiklass, interfeys, maydon, metod
{@link reference}Havolaklass, interfeys, maydon, metod
{@value}O‘zgaruvchi qiymatining tavsifistatik maydon


O‘zgaruvchini hujjatlashtirish uchun quyidagi deskriptorlardan foydalanish mumkin: @see, @serial, @serialField, {@value}, @deprecated. Klasslar va interfeyslar uchun quyidagi deskriptorlardan foydalanish mumkin: @see, @author, @deprecated, @param, @version. Metodlarni quyidagi deskriptorlar yordamida hujjatlashtirish mumkin: @see, @return, @param, @deprecated, @throws, @serialData, {@inheritDoc}, @exception.

{@link}, {@docRoot}, {@code}, {@literal}, @since va {@linkplain} deskriptorlarini istalgan joyda qo‘llash mumkin.

Misol

Metodni hujjatlashtirishda Javadoc belgilash usulidan foydalanishga misol. O‘zgaruvchilarning turlarini ko‘rsatish shart emas.

 /**
  * <p>Проверяет, допустимый ли ход.</p>
  * <p>Например, чтобы задать ход e2-e4, напишите isValidMove(5,2,5,4);
  * Чтобы записать рокировку, укажите, откуда и куда ходит король.
  * Например, для короткой рокировки чёрных запишите isValidMove(5,8,7,8);</p>
  *
  * @param fromCol Вертикаль, на которой находится фигура (1=a, 8=h)
  * @param fromRow Горизонталь, на которой находится фигура (1...8)
  * @param toCol   Вертикаль клетки, на которую выполняется ход (1=a, 8=h)
  * @param toRow   Горизонталь клетки, на которую выполняется ход (1...8)
  * @return true, если ход допустим, и false, если недопустим
  */
  boolean isValidMove(int fromCol, int fromRow, int toCol, int toRow) {
      . . .
  }

Havolalar

Maqolalar