Commentaar in Java™ source code

Commentaar in Java™ source code
In Java zijn drie verschillende soorten commentaar mogelijk:
//
Geldig tot het eind van de regel
/* */
Geldig van begintag tot en met eindtag, verspreidt over meerdere regels. Niet genest.
/** */
Idem, maar tekst die tussen dit commentaar staat wordt door javadoc omgezet in HTML code. Dit is dus
erg handig als je je code wilt beschrijven. Verder herkent javadoc een aantal tags, die hieronder
weergegeven zijn. Deze tags moeten tussen het /** en */ commentaar opgenomen worden.
Class/Interface documentatie tags:
@author
@version
@since
@see
Field documentatie tags:
@see
Constructor/Method documentatie tags:
@param
@return
@exception
@see
Hieronder volgt een beschrijving van elke type tag.
@author
Met behulp van deze tag kan je de naam van de auteur(s) in de documentatie opnemen. Dit geldt alleen op
class niveau. Voorbeeld:
@author
M. Lindhout
@version
Hiermee kan je een versie aanduiding introduceren. Voorbeeld
@version
1.0
@since
Deze tag geeft aan dat een feature of verandering bestaat sinds de aangegeven versie.
@since
1.0
@see
Hiermee is het mogelijk verwijzingen aan te leggen naar andere Classes en URL’s op het WWW. Bij
verwijzingen naar andere classes moet de volledige cassnaam opgegeven worden. Er zijn meerdere see-tags
mogelijk per operation. Voorbeeld:
@see
java.lang.System.currentTimeMillis
@see
http://come.to/robbieng
@param
Gebruik deze tag om de parameters van een operation te beschrijven. Er zijn meerdere param-tags
mogelijk. Voorbeel:
@param
obs
Het waarschuwende observable object
@param
object Een eventueel meegegeven object
@return
Hiermee kan de returnwaarde van een operation beschreven worden. Er is er maar een per operation
mogelijk (Ever seen an operation that return more than one value?). Voorbeeld:
@return
Het eersvolgende element uit de lijst
@exception
Deze tag beschrijft de verschillende exceptions die een operation kan throwen. Er kunne dus meerdere tags
per operation voorkomen. De naam van de exception moet de volledige classnaam zijn. Voorbeeld:
@exception
java.lang.NumberFormatException