10 Dokumentation - Universität Stuttgart
10 Dokumentation - Universität Stuttgart
10 Dokumentation - Universität Stuttgart
Erfolgreiche ePaper selbst erstellen
Machen Sie aus Ihren PDF Publikationen ein blätterbares Flipbook mit unserer einzigartigen Google optimierten e-Paper Software.
<strong>10</strong>.5 <strong>Dokumentation</strong>smanagement<br />
ST I<br />
Beispiel Javadoc (1)<br />
<strong>Dokumentation</strong>serstellung aus kommentiertem Quellcode<br />
1. Einfügen von Kommentaren in den Quellcode<br />
Überblick<br />
package<br />
Klassen, Interfaces<br />
Konstanten, Attribute, Methoden<br />
/**<br />
* Registers the text to display in a tool tip. The text<br />
* displays when the cursor lingers over the component.<br />
*<br />
* @param text The string to display. If the text is null,<br />
* the tool tip is turned off for this component.<br />
*/<br />
public void setToolTipText(String text)<br />
{<br />
//...<br />
}<br />
2. Ausführen des Javadoc-Tools, welches den Quellcode<br />
nach Deklarationen und Kommentaren durchsucht<br />
und HTML-Seiten generiert<br />
© 2013 IAS, <strong>Universität</strong> <strong>Stuttgart</strong> 486
Change language