Zu dieser Karteikarte gibt es einen kompletten Satz an Karteikarten. Kostenlos!
37
KE5: Dokumentation
Die Java-Umgebung enthält das Dienstprogramm javadoc, das dazu dient, Referenzdokumentationen im HTML-Format aus den Java-Quelltexten zu erzeugen. Die Java-API-Referenz, die wir in Kapitel 26 kennen gelernt haben, ist eine auf diese Weise generierte Referenzdokumentation der Java-Standardbibliothek.
Das Javadoc-Dienstprogramm extrahiert die Dokumentationskommentare, die direkt vor einer Klassen-, Schnittstellen-, Konstruktor-, Methoden- oder Attributdefinition stehen. Die Dokumentationskommentare können noch die in Tab. 31-2 angegebenen Javadoc-Schlüsselwörter, die alle mit dem Zeichen @ beginnen, enthalten.
Sie traten in verschiedenen Programmbeispielen dieses Kurses auch schon auf.
Das Javadoc-Dienstprogramm extrahiert die Dokumentationskommentare, die direkt vor einer Klassen-, Schnittstellen-, Konstruktor-, Methoden- oder Attributdefinition stehen. Die Dokumentationskommentare können noch die in Tab. 31-2 angegebenen Javadoc-Schlüsselwörter, die alle mit dem Zeichen @ beginnen, enthalten.
Sie traten in verschiedenen Programmbeispielen dieses Kurses auch schon auf.