Tartalomjegyzék:

Hová tegyem a Javadoc megjegyzéseket?
Hová tegyem a Javadoc megjegyzéseket?

Videó: Hová tegyem a Javadoc megjegyzéseket?

Videó: Hová tegyem a Javadoc megjegyzéseket?
Videó: Generating our own JavaDocs for our Package 2024, November
Anonim

Az javadoc segédprogram lehetővé teszi tegye a ti Hozzászólások közvetlenül a kódod mellett, a ""-ben. Jáva " forrásfájlokat. Ha elégedett a kódjával és Hozzászólások , egyszerűen futtatja a javadoc parancsot, és az Ön HTML-stílusát dokumentáció automatikusan létrejön az Ön számára.

Aztán hogyan lehet megjegyzéseket hozzáadni egy Javadochoz?

Használatkor tartsa szem előtt a következőket Javadoc megjegyzés hozzáadása (Alt+Shift+J): ide add hozzá a megjegyzés egy mezőre, helyezze a kurzort a meződeklarációra. Nak nek add hozzá a megjegyzés egy metódushoz helyezze a kurzort a metódusban vagy annak deklarációjában bárhol.

mi a haszna a Javadoc megjegyzéseknek? Javadoc egy olyan eszköz, amely a JDK-val érkezik, és az is használt generálására Jáva kóddokumentáció HTML formátumban től Jáva forráskód, amelyhez előre meghatározott formátumú dokumentációra van szükség. Az alábbiakban egy egyszerű példa látható, ahol a /*… belsejében lévő sorok. */ vannak Jáva többsoros Hozzászólások.

Ezért hova tegyem a Javadoc-ot?

JavaDoc megjegyzéseket a forrásfájl három különböző helyére helyezhet el:

  1. Közvetlenül a nyilvános osztály kihirdetése előtt.
  2. Közvetlenül a nyilvános mezővé nyilvánítás előtt.
  3. Közvetlenül egy nyilvános metódus vagy konstruktor deklarálása előtt.

Hogyan írhatok Javadoc megjegyzéseket az Intellijben?

3 válasz. Gépelje be a /** + billentyűt, majd nyomja meg az Enter billentyűt felette egy metódusaláírás jön létre Javadoc csonkok neked. tudsz használat a „Fix doc megjegyzés '. Alapértelmezett billentyűparancsa nincs, de a Billentyűzetkiosztásban hozzárendelheti az Alt + Shift + J billentyűkombinációt, mert ez a billentyűparancs másra nem használható.

Ajánlott: