INHOUDSOPGAWE:

Waar plaas ek Javadoc-opmerkings?
Waar plaas ek Javadoc-opmerkings?

Video: Waar plaas ek Javadoc-opmerkings?

Video: Waar plaas ek Javadoc-opmerkings?
Video: How to Setup Multinode Hadoop 2 on CentOS/RHEL Using VirtualBox 2024, November
Anonim

Die javadoc nut laat jou toe sit jou kommentaar reg langs jou kode, binne jou ". java " bronlêers. Wanneer jy tevrede is met jou kode en kommentaar , hardloop jy eenvoudig die javadoc opdrag, en jou HTML-styl dokumentasie word outomaties vir jou geskep.

Hoe voeg u dan opmerkings by 'n Javadoc?

Hou die volgende in gedagte wanneer u dit gebruik Voeg Javadoc-opmerking by (Alt+Shift+J): Aan byvoeg a kommentaar lewer na 'n veld, plaas die wyser op die veldverklaring. Om byvoeg a kommentaar lewer na 'n metode, plaas die wyser enige plek in die metode of op sy verklaring.

wat is die nut van Javadoc-kommentaar? Javadoc is 'n instrument wat by JDK kom en dit is gebruik word vir generering Java kode dokumentasie in HTML-formaat vanaf Java bronkode, wat dokumentasie in 'n voorafbepaalde formaat vereis. Hier volg 'n eenvoudige voorbeeld waar die lyne binne /*…. */is Java veellyn kommentaar.

Waarvan, waar plaas ek Javadoc?

Jy kan JavaDoc-opmerkings op enige van drie verskillende plekke in 'n bronlêer plaas:

  1. Onmiddellik voor die verklaring van 'n openbare klas.
  2. Onmiddellik voor die verklaring van 'n openbare veld.
  3. Onmiddellik voor die verklaring van 'n openbare metode of konstruktor.

Hoe skryf ek Javadoc-opmerkings in Intellij?

3 Antwoorde. Tik /** + en druk dan Enter bo 'n metode handtekening sal skep Javadoc stompies vir jou. Jy kan gebruik die aksie 'Fix doc kommentaar lewer '. Dit het nie 'n verstekkortpad nie, maar jy kan die Alt + Shift + J-kortpad daaraan toewys in die Sleutelkaart, want hierdie kortpad word vir niks anders gebruik nie.

Aanbeveel: