Javadocmerkintöjä

Javadocmerkintöjä ovat erityisiä kommentteja Java-lähdekoodissa, jotka on suunniteltu Javadoc-työkalulla automaattisesti luomaan ohjelmistodokumentaatiota. Nämä merkinnöt alkavat aina tunnisteella /* ja päättyvät tunnisteella */, ja ensimmäinen merkki sisällä on tähdellä (*). Javadoc-merkinnät sijaitsevat välittömästi luokan, rajapinnan, konstruktorin, metodin tai kentän määrittelyn edellä.

Merkinnät voivat sisältää paitsi tavallista tekstiä, myös erityisiä Javadoc-tageja, jotka alkavat @-merkillä. Yleisimpiä tageja ovat @param kuvaamaan metodin parametria, @return kuvaamaan metodin palautusarvoa ja @throws kuvaamaan mahdollisesti esitettävää poikkeusta. Muita hyödyllisiä tageja ovat @see viittaamaan toiseen luokkaan tai metodiin, @author ilmoittamaan tekijän ja @version ilmoittamaan ohjelmistoversion.

Javadoc-työkalu käsittelee nämä merkinnöt ja luo niiden perusteella HTML-muotoista dokumentaatiota, joka on helppolukuista ja selkeää. Hyvin kirjoitetut Javadoc-merkinnät ovat olennainen osa laadukasta ohjelmistokehitystä, sillä ne auttavat muita kehittäjiä ymmärtämään koodin tarkoitusta, käyttöä ja toimintaa ilman tarvetta syventyä itse koodin yksityiskohtiin. Ne edistävät koodin ylläpidettävyyttä ja uudelleenkäytettävyyttä.