SDA SE Wiki

Software Engineering for Smart Data Analytics & Smart Data Analytics for Software Engineering

User Tools

Site Tools


Differences

This shows you the differences between two versions of the page.

Link to this comparison view

research:jtransformer:javadocschreiben [2018/05/09 01:59] (current)
Line 1: Line 1:
 +Eclipse bietet **Unterstützung beim Schreiben** von Javadoc. Hier ein paar Tipps:''/​** [Enter]''​ Vor einer Methode oder einer Klasse fügt ein Javadoc-Template ein.''​@ [Ctl]+[Space]''​ Innerhalb von Javadoc gibt eine Liste der möglichen Javadoc-Tags zur Auswahl.''#​ [Ctl]+[Space]''​ Nach einem Klassennamen bietet eine Liste der Methoden der Klasse an.
  
 +\\ 
 +Wir **dokumentieren mindestens**:​
 +
 +
 +  * Jede Klassen  ​
 +  * Jede ''​public''​-Methode einschließlich ​
 +    *der Parameter, ​
 +    *des Rückgabewertes und 
 +    *der Exceptions.
 +
 +[[http://​java.sun.com/​j2se/​1.4.2/​docs/​tooldocs/​solaris/​javadoc.html#​javadoctags|http://​java.sun.com/​j2se/​1.4.2/​docs/​tooldocs/​solaris/​javadoc.html#​javadoctags]][[:​file:​...c:​.program%20files.java.j2sdk1.4.2_02.docs.tooldocs.windows.javadoc.html#​javadoctags|file:​...c:​.program%20files.java.j2sdk1.4.2_02.docs.tooldocs.windows.javadoc.html#​javadoctags]]
 +
 +
 +
 +\\ 
 +Außerdem integrieren wir das **Javadoc von Eclipse für das Paket jdt.core.dom**. Das geht wir folgt:
 +
 +
 +  - Man lade die Sourcen aus dem Verzeichnis ''​...\plugins\org.eclipse.jdt.source_3.0.0\src\org.eclipse.jdt.core_3.0.0''​ als eigenes Projekt.
 +  - Dafür erstelle man Javadoc in ein über http erreichbares Verzeichnis. ​
 +  - Auf der Seite 2 des Dialogs zur Javadoc Generierung setze man ein Häckchen beim Paket ...jdt.core ​
 +  - Dieses Paket "​konfiguriere"​ man, indem man die URL des soeben erzeugten Javadoc angibt. ​
 +  - Wenn man jetzt Javadoc für das eigene Projekt erstellt, wird das Javadoc zu jdt.core integriert. ​
research/jtransformer/javadocschreiben.txt · Last modified: 2018/05/09 01:59 (external edit)

SEWiki, © 2019