En liste over javadoc tagger
Javadoc, eller "The Java API Dokumentasjon Generator," genererer HTML-sider som inneholder API dokumentasjon fra Java-kildefilene. Forstå javadoc-koder kan gjøre programmeringen med Javadoc en strømlinjeformet prosess, som din kunnskap om disse kodene vil tillate deg å skrive kode raskt og effektivt. En rekke ulike javadoc tags eksisterer, hver spesifikke for en bestemt del av koden som gjør det mulig for automatisk generering av en API fra kildekoden.
Naviger til Liste over javadoc tagger
Åpne en nettleser av ditt valg og navigere til listen over javadoc tagger på Oracle nettstedet. Øverst på siden kan du se linken til javadoc koder under "Reference Guide". Ved å velge denne koblingen tar deg til en liste over javadoc koder som er tilgjengelige for deg å bruke.
Viktige Syntax Notater
Forstå syntaksen til javadoc koder er viktig for å gjennomføre dem på riktig måte. Javadoc tags starter med "@" og er også store og små bokstaver. Det er viktig at du følger disse syntaksregler når du arbeider med javadoc koder. Et eksempel på en Javadoc tag for forfatteren ville se slik ut:
@forfatter
Merk at koden begynner med "@" symbol og er alle små, slik tilfellet er på den medfølgende listen over javadoc koder.
Nøkkel javadoc tagger
Der en rekke JavaDoc koder som kan anvendes i et bredt spekter av applikasjoner. Nedenfor er noen viktige javadoc koder og deres funksjoner:
@author - Denne koden brukes til å legge til en forfatter oppføring. Du kan ha flere @author koder per dokument samt flere navn per tag.
@see - Denne koden brukes til å lage en kobling som er definert av en URL #VERDI. Eksempel syntaks å bruke denne koden er som følger:
@see <a href="test.html> Test </a>
Dette vil generere en link til testside, vises som "Test".
@version - Denne taggen brukes til å vise gjeldende versjonsnummeret for programvaren som blir programmert.
Forskjellen mellom Block og Inline tagger
Et viktig poeng når det gjelder javadoc koder er deres plassering i koden. Blokker kodene kan bare plasseres i koden delen, som følger hoved beskrivelse. Inline-koder, på den annen side kan plasseres hvor som helst i hoved beskrivelse og / eller i kommentarfeltet for blokk-koder, og nomineres i listen over koder klammeparentes ({@tag}). Det er viktig å bruke javadoc koder på de riktige stedene.