Programmeren in Java/Appendix B
Uiterlijk
Javadoc
[bewerken]Java-code: javadoc
/**
* Geeft de naam van de persoon
* @author Jan Janssens
* @param idnr identificatienummer
* @return naam van een persoon
* @since 01-01-2000
* @version 2.1
* @exception PersonNotFoundException Wanneer er geen persoon
met het id nummer kan worden gevonden
*/
String getName(int idnr)
{
…
}
- @author - Naam van de programmeur
- @deprecated - Markeert de methode als verouderd (deprecated).
- @exception - Geeft aan wanneer een uitzondering (exception) veroorzaakt kan worden (thrown) door een methode — zie ook @throws.
- @param - Definiëert een methodeparameter. Verplicht voor iedere parameter.
- @return(s) - Documenteert de teruggegeven waarde. Moet niet gebruikt worden voor methoden die een void teruggeven.
- @see - Geeft een verwijzing aan naar een andere methode of klasse.
- @since - Geeft aan wanneer een methode toegevoegd is aan de klasse.
- @throws - Documenteert de veroorzaakte uitzondering (thrown exception). Een synoniem voor @exception, geïntroduceerd in Javadoc 1.2.
- @version - Geeft het versienummer van een methode of klasse aan.
Testcode
[bewerken]Je kan testcode heel makkelijk aan- of uitschakelen door er net vóór de tekens //* te zetten en er net na de tekens //*/. Door de eerste / weg te laten wordt alles commentaar.
Java-code: actieve code
//*
cijfer = 9;
invoer = “test”;
//*/
Java-code: geïnactiveerd
/*
cijfer = 9;
invoer = “test”;
/*/