Unsere Datenschutzrichtlinie wird in Kürze aktualisiert. Bitte sehen Sie sich die Vorschau an.

Jetzt lerne ich Java 6

Javadoc-Kommentare

Testen Sie unsere 2021 Kurse

10 Tage kostenlos!

Jetzt testen Alle Abonnements anzeigen
Mit dem JDK kommt ein Werkzeug mit auf Ihren Rechner, das automatisch Dokumentationen erstellt: 'Javadoc'. Dieses Feature übernimmt die Zusatzinfos, die Sie - in einer vorgegebenen Form - nach einem Kommentar mit zwei Sternchen angeben. Damit nimmt Ihnen das System zwar die Arbeit nicht ab, macht sie aber viel leichter!
09:47

Transkript

Diese Kommentare sind spezielle Kommentare für ein mit dem JDK geliefertes Werkzeug - Javadoc. Damit können Sie automatisch Dokumentation erstellen lassen. Und wie eine solche Dokumentation aussieht, können wir uns direkt anschauen. Wir haben bei der Installation unseres JDKs die Dokumentation heruntergeladen von der Firma Sun. Und die haben wir installiert. Wir können uns hier in NetBeans jetzt diese Dokumentation mal kurz aufrufen, indem wir hier auf "Help" gehen, und dann hier "Javadoc References". Und da können wir uns einfach mal die "Java Platform SE 6" anschauen. Dann sehen wir eine solche Dokumentation. Ist Dokumentation ganz schick, ist automatisch erstellt worden. Wir wechseln einfach mal kurz hier in irgendetwas hinein, was uns interessiert: zum Beispiel - java.io, für Ein- und Ausgabe. Klicken mal da drauf, und wir sehen, das Ganze hat immer den gleichen Stil und ist auch HTML. Das heißt, wir können uns das Ganze im Browser anschauen. Hier drinnen sehen wir dann irgendwann, dass das Ganze immer den gleichen Aufbau hat. Wir sehen einen Packagename, Interface Summary, Class Summary, also alle Klassen, die da drin sind, alle Interfaces, die da drin sind. Und wir haben immer da vorne den Namen, der als halber Link angelegt ist, und da hinten eine kurze Beschreibung. Und wenn wir uns jetzt hier einfach mal was raussuchen, zum Beispiel, mich interessiert, was ein StringReader ist, ich klicke mal da drauf -, dann sehen wir auch hier so ein kleines Schaubild. Wir sehen dann hier die sogenannten Field-Descent-Eigenschaften. Das sind also Variablen, die Sie angelegt haben - lock. Dann sehen wir die verschiedenen Methoden, die Rückgabewerte und so weiter und so fort. Dies muss keiner per Hand schreiben, oder indirekt gesprochen - schon, aber das Ganze geht recht einfach - mit Hilfe von Javadoc-Kommentaren. Schauen wir uns das direkt in unserem NetBeans noch einmal an. Wenn wir einen solchen Kommentar beginnen / ** bedeutet das nun für das Werkzeug Javadoc - das ist ein Kommentar für mich. Und diese Kommentare haben ein eigenes Format, wie Sie sich sicher vorstellen können. Und wenn Sie sich an das Format halten, wird später automatisch eine passende Dokumentation erstellt. Und das schauen wir uns direkt hier schon mal an. Sie können Javadoc auch per Hand aufrufen, aber ich bin da etwas faul, und gehe einfach nach "Build" - "Generate Javadoc for "Kommentare". Ich klick mal drauf. Und dann arbeitet hier im Hintergrund Javadoc. Und es öffnet sich in meinem Browser, voila: eine Dokumentation. Nun, sie ist noch ein - ja, wie will ich sagen? - bisschen wenig ausgefüllt die ganze Geschichte. Aber man sieht schon, das ist das gleiche Format. Wir sehen hier alle Klassen unseres Projekts. Hier in unserem Fall haben wir nur eine Main-Klasse. Und wenn wir hier auf die Main-Klasse mal draufklicken, da sehen wir wieder dieses kleine Schaubild hier, wir sehen, dass unsere Main-Klasse von Object abgeleitet worden ist, und dass es einen einzigen Konstruktor gibt, und eine Methode mit dem Namen "main", mit den Argumenten, die da übergeben werden. Und hier drunter haben wir sogar noch Methoden-Details. Da steht also Okay. Es gibt eine Methode "main", die hat diesen Zugriffsmodifizierer, ist "static", und hat die Parameter. Und darunter steht sogar auch für den Parameter "args": Was das Ganze zu bedeuten hat. Also das Ganze wurde automatisch aus diesem Code hier generiert. Und das ist eine klasse Sache, finde ich. Und weil das Ganze so schön war, wollen wir jetzt natürlich auch herausfinden, wie schreibt man diese Kommentare. Nun, es gibt auf der Sun-Seite dazu eine eigene Anleitung. Die habe ich Ihnen einmal herausgesucht, dafür öffne ich kurz den Browser. Und machen wir einen Doppelklick hier auf eine Verknüpfung, die ich mir auf meinem Desktop abgelegt habe. Sie finden diese Dokumentation unter http://java.sun.com unter der Java 2 Standard Edition - Javadoc Da gibt es also einen eigenen Artikel. Und ich hab' mir hier den Artikel "writtingdoccomments" herausgesucht. Und hier finden Sie also eine leider englischsprachige Dokumentation, was man da alles so verwenden kann. Also hier finden Sie Hilfe, wenn Sie sich dafür mehr interessieren. Aber eine gute Entwicklungsumgebung wie NetBeans hilft uns auch dort mal wieder weiter. Und zwar finden Sie unter "Tools" hier einen Punkt, der sich nennt "Auto Comment". Und klicke ich hier mal auf "Auto Comment", dann öffnet sich ein eigenes Fenster, und ich sehe hier auf der linken Seite schon hier meine Klasse und Methoden, den Konstruktor hier. Und wenn ich hier etwas auswähle, dann kann ich schon auf der rechten Seite entsprechende Kommentare geben. Die Kommentare sind grundsätzlich so aufgebaut, dass wir zuerst eine Kommentarzeile haben, oder einen Kommentartext - in dem können Sie sogar ein bisschen HTML verwenden - und dann können Sie noch sogenannte "tags" hinzufügen. Die sind genannt natürlich, die sind festgelegt natürlich, die beginnen alle mit einem @-Zeichen und dann einem Namen. Und dahinter kann man dann eben schreiben, was das Ganze so auf sich hat. Und damit Sie das Ganze auch nochmal in der Praxis sehen, legen wir doch kurzerhand mal hier in unserem Projekt eine weitere Java-Klasse an. Da greife ich jetzt ein bisschen vor. Ich sage: wir wollen Person als Klasse anlegen. Damit haben wir das Ganze jetzt schon, und wir sehen auch hier sind diese speziellen Javadoc-Kommentare bereits drin. Und jetzt gehe ich unter "Tools" auf "Auto Comment", wähle mir meine Klasse hier aus, und schreibe hier jetzt hinein, für was die Klasse gut sein soll. Okay. Sie sehen jetzt, während ich das Ganze hier schreibe, dass wir hier unten auch noch gewissen HTML-Text verwenden könnten. Das heißt, mir ist das hier zum Beispiel wichtig, dann kann ich das auf "bold" setzen, dann wird das später auch hervorgehoben. Man sieht, ein B wird noch außen herum gesetzt. Und hier bei "Tags", wenn ich so einen auswähle, hier zum Beispiel @author - der Autor, dann sieht man hier, da steht noch Administrator. Da will ich natürlich "Helge Maus" drin haben, und vielleicht noch meinen Firmennamen. Und wenn Sie wollen, können Sie auch weitere Tags hinzufügen. Dazu geht man hier auf "New". Und da sehen wir jetzt also diese verschiedenen Tags, und können also hier zum Beispiel "@version" herausnehmen. Und sagen, das ist die Version 0.1. Wir sind grade erst am Entwickeln des Ganzen. Und so fügen wir jetzt also unsere Kommentare hinzu. Und wenn ich das ganze Fensterchen jetzt hier schließe, dann sehen wir, das Ganze wurde hier oben auch schön korrekt eingetragen. Das Ganze machen wir jetzt auch noch - hier ist unser Konstruktor - mit einer eigenen Methode. Ich setze einfach mal auf "protected" kein Rückgabewert, nennen wir einfach mal "test". Und wir wollen gerne einen "string name" übergeben haben, und einen "string vorname" Das Ganze brauch' ich eigentlich gar nicht zu tun. Doch fügen wir mal ganz normalen Kommentar hinein. Und auch hier gehen wir dann wieder auf "Tools" - "Auto Comment". Wir sehen, jetzt ist hier "test" aufgetaucht. Wir wählen uns das Ganze aus, schreiben jetzt hier: Diese Methode tut noch nichts. Sie schreiben natürlich dann hinein, was Ihre Methode eigentlich tun soll. Und als Text können wir hier noch für Parameter hinzufügen. Man weiß ja nicht so, warum wird diese Methode überhaupt hineingenommen, oder aufgerufen. Als Parameter sagen wir "name": Dies ist der Familienname Dann sagen wir: wir wollen noch einen haben, auch einen Parameter, und zwar - "vorname": Dies ist der Vorname Und damit wär' ich soweit fertig. Wir können hier mal refreshen jetzt alles. Okay, scheint alles syntax-konform zu sein. Ich mach das Ganze zu. Nun haben wir also hier diese Methode schön dokumentiert. Und jetzt kommt natürlich das große Ereignis, speichern wir dafür mal alle Klassen. Ich möchte jetzt gerne eine Dokumentation für dieses ganze Projekt erstellen. Unser Projekt besteht zur Zeit aus zwei Java-Klassen: Main und Person. Wir gehen also auf "Build", sagen "Generate Javadoc for "Kommentare" Das dauert jetzt ein bisschen. Jetzt öffnet sich mein Browser und wir sehen: okay, wir bekommen jetzt zwei Klassen - Main und Person. Wir klicken mal "Person" als Klasse an. Wir sehen jetzt also hier die Klasse, wie sie abgeleitet worden ist. Wir sehen den Konstruktor, wir sehen eine Methode "test" wurde hier angelegt. Wie sehen hier "Diese Methode tut noch nichts" - das haben wir also hier reingeschrieben als Javadoc-Kommentar. Ist "protected" und "void". Wir können uns diese Methode noch näher anschauen. Klicken wir drauf. Wir sehen also den kompletten Aufruf, den Kommentar. Und auch die Parameter sind schön dokumentiert. Ich denke, das genügt zum Anfang. Sie haben gesehen, was Sie mit Javadoc alles machen können. Und ich hoffe, ich hab Sie ein bisschen dafür begeistert, Ihre Programmcodes zu dokumentieren.

Jetzt lerne ich Java 6

Steigen Sie ein in die Programmierung mit Java 6, lernen Sie die Grundlagen kennen und unternehmen Sie anschließend Ihre ersten Schritte in der objektorientierten Programmierung.

12 Std. 27 min (98 Videos)
Derzeit sind keine Feedbacks vorhanden...
 

Dieser Online-Kurs ist als Download und als Streaming-Video verfügbar. Die gute Nachricht: Sie müssen sich nicht entscheiden - sobald Sie das Training erwerben, erhalten Sie Zugang zu beiden Optionen!

Der Download ermöglicht Ihnen die Offline-Nutzung des Trainings und bietet die Vorteile einer benutzerfreundlichen Abspielumgebung. Wenn Sie an verschiedenen Computern arbeiten, oder nicht den ganzen Kurs auf einmal herunterladen möchten, loggen Sie sich auf dieser Seite ein, um alle Videos des Trainings als Streaming-Video anzusehen.

Wir hoffen, dass Sie viel Freude und Erfolg mit diesem Video-Training haben werden. Falls Sie irgendwelche Fragen haben, zögern Sie nicht uns zu kontaktieren!