Sisukord:

Kuidas Javadoci kirjutada?
Kuidas Javadoci kirjutada?

Video: Kuidas Javadoci kirjutada?

Video: Kuidas Javadoci kirjutada?
Video: Создание аннотации в java [Java Annotations | Reflection api] 2024, November
Anonim

Javadoci kodeerimise standard

  1. Kirjutage Javadoc lugeda lähtekoodina.
  2. Avalik ja kaitstud.
  3. Kasutage selle jaoks standardset stiili Javadoc kommenteerida.
  4. Kasutage lihtsaid HTML-märgendeid, mitte kehtivat XHTML-i.
  5. Kasutage singlit

    märgendit lõikude vahel.

  6. Kasutage singlit
  7. loendi üksuste silt.
  8. Defineerige terav esimene lause.

Kuidas teha sellega seoses Javadoci?

pakkuda klassi, liidese või enumi versiooni. Valige Genereeri JavaDoc ” menüüst Projekt ja ilmub viisard. Määrake selle asukoht JavaDoc fail teie arvutis, vaikimisi on see C-draivis. Valige projekt ja seejärel paketid, mille jaoks soovite selle luua JavaDoc faili.

Seejärel tekib küsimus, mis on javadocid ja millal neid kasutada? Javadoc on JDK-ga kaasas olev tööriist ja see on nii kasutatud HTML-vormingus Java koodi dokumentatsiooni genereerimiseks Java lähtekoodist, mis nõuab dokumentatsiooni etteantud vormingus. */ on Java mitmerealised kommentaarid. Samamoodi on // ees olev rida Java üherealine kommentaar.

Arvestades seda, mis on Javadoc Command?

javadoc on käsk -line tööriist spetsiaalsete kommentaaride (nn doc-kommentaarideks) ekstraheerimiseks Java lähtefailidest ja neid sisaldava hõlpsasti kasutatava HTML-failipuu genereerimiseks. Kommentaarid võivad sisaldada standardset HTML-märgistust ja javadoc @sildid. Java API spetsifikatsioon on näide sellest javadoc toodab.

Kuidas Javadoc-faili avada?

Asukoha leidmiseks Javadoc , sirvige oma kausta Kasutaja (Windows 7 puhul on see C:Users*Kasutajanimi*), seejärel sirvige kausta sunspotfrcsdk/doc/ javadoc . Topeltklõpsake indeksil. html-faili avatud see teie vaikeveebibrauseris.

Soovitan: