JavaDoc: automatisch @see Tag

Status
Nicht offen für weitere Antworten.

Dragonfire

Bekanntes Mitglied
Hi,
gibt es für eclipse ein Plugin,
welches automatisch Kommentare mit einem @see Tag versieht?

Wäre praktisch wenn es ein Plugin geben würde,
welches ein "see" Tag in der JavaDoc Methode hinzufügt,
welche die zu dokumentieren Methode aufruft.

Bei JAutodoc habe ich die Funktion leider nicht gefunden ...
 

Dragonfire

Bekanntes Mitglied
In eclipse gibt es ja die Möglichkeiten sich die "Typ Hierarchie" und "Call Hierarchie" anzuzeigen.
Könnte die Methoden in der "Call Hierarchie" dir direkt die zu dokumentierende Methode aufrufen,
sowie die ersten Methoden in der "Typ Hierarchie" automatisch zum JavaKommentar (see-Tag) hinzugefügt werden?

Bsp.:

Java:
public class Class1 {
	
	public void Methode1() {
		...
	}

}

public class Class2 extends Class1{
	
	@Override
	public void Methode1() {
		...
	}
}

public class Class3{
	
	public void anotherMethod) {
		Class1 o = new Class1();
		o.Methode1();
		...
	}
}

Würde dann so dokumentiert werden:

Java:
public class Class1 {
	/**
	 * Comment
	 * @see Class2#Methode1()
	 * @see Class3#anotherMethod()
	 */
	public void Methode1() {
		...
	}

}

Für den Klassenkommentar wäre es auch praktisch ....

Java:
/**
 * Comment
 * @author Dragonfire
 * @see Class2
 * @see Class3
 */
public class Class1 {
    ...
}
 

Wildcard

Top Contributor
Ich würde dir empfehlen es mit den @see nicht zu übertreiben, das lenkt vom eigentlichen Inhalt ab. Erstelle diese Links händisch, bei echter Relevanz für den Konsument der Methode.
 

Dragonfire

Bekanntes Mitglied
Ich würde dir empfehlen es mit den @see nicht zu übertreiben, das lenkt vom eigentlichen Inhalt ab. Erstelle diese Links händisch, bei echter Relevanz für den Konsument der Methode.

Hast recht,
bei Klassenkommentare macht das @see für Subtypen ja keinen Sinn,
da es schon automatisch generiert wird (Direct Known Subclasses).

Ich wollte den Ansatz fahren,
dass mir alle Methoden in die @see Tags eingefügt werden und ich dann die "unwichtigen" lösche.
 

Wildcard

Top Contributor
Vielleicht gibt es was du suchst, und wenn nicht, du würdest dich wundern wie einfach es ist Eclipse PlugIns zu schreiben...
Ich halte den händischen Weg allerdings für die bessere Variante, den Java Doc ist wichtig und der Inhalt sollte gut überlegt sein.
 

Dragonfire

Bekanntes Mitglied
Ich halte mich dann mal an deinen Rat und mache dies händisch ...
Wenn wer trotzdem ein Plugin kennt,
der kann es gerne posten ;)
 
Status
Nicht offen für weitere Antworten.
Ähnliche Java Themen
  Titel Forum Antworten Datum
H Mit Eclipse automatisch JavaDoc-Struktur einfügen? IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 6
A Javadoc Klassen-Dokumentation wird nicht angezeigt IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 0
J Eclipse portable javadoc IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 0
J Unter OS X: Javadoc generieren (wie???) IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 0
G Eclipse navigation per tastatur im javadoc nicht möglich? IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 3
N NetBeans Javadoc Problem IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 2
J Eclipse javadoc offline IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 8
Guybrush Threepwood Eclipse Javadoc generieren IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 3
A Javadoc "Korrektur"-Tool ? IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 3
S Eclipse Javadoc an Methode mit @override IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 8
N Eclipse eclipse javadoc noframes IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 2
R eclipse - kommentare in bestehende javadoc hinzufügen IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 2
I JavaDoc im Team IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 3
N NetBeans javadoc mit Zeilenumbrüchen generieren IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 7
H maven-javadoc-plugin: package does not exist IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 1
D Eclipse JEE 6 Javadoc/Source in Eclipse einbinden IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 2
mongole JavaDoc in Eclipse anzeigen lassen IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 2
S Eclipse: Javadoc Exception Error IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 5
S Sämtliche Javadoc quellen weg IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 2
S Maven / Javadoc als jar deployen IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 7
P Javadoc - Autofinder Plugin für Location Path IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 24
C kleine javadoc popups in eclipse IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 4
Natorion Javadoc Syntax-Highlighting IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 5
E Javadoc bei Eclipse nicht richtig lesbar ( zu klein) IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 6
E JavaDoc IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 4
A JavaDoc Tool in NetBeans IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 3
F Problem mit eclipse formatter, javadoc und generics. IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 4
T Netbeans Javadoc mit eigenen Kommentaren IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 4
vogella Javadoc - automatische Version mit subversion IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 3
T javadoc und IllegalArgumentException IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 5
Paule JavaDoc Kommentare wewrden nicht angezeigt IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 5
K JAVADOC von selbst generieren IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 6
S Woher bekommt man die JFace-Javadoc? IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 10
M Javadoc-HTML-Seiten in Eclipse? IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 8
D JavaDoc & Netbeans IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 3
S javadoc und NetBeans IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 3
G Eclipse und Javadoc einrichten, Forum schon durchsucht. IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 4
S Netbeans und Javadoc - Shortcut? IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 2
A Struts-Doku (Javadoc) in Eclipse einbinden IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 6
R HTML Doku erzeugen mit Eclipse und Javadoc IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 3
8 Javadoc mit Eclipse IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 7
C javadoc-problem IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 3
M Eclipse und JavaDoc von eigenen JARs etc. IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 4
S JavaDoc und Netbeans IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 3
P JavaDoc: Packages dokumentieren IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 3
H JBuilder: Javadoc-Erzeugung unterbinden IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 2
S NetBeans IDE Version 3.5.1 mit dem Javadoc anbinden ?! IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 2
jan_89 args, wird Automatisch hinzugefügt IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 2
LimDul Eclipse Fields automatisch final IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 1
F Console Kommandos automatisch eingeben nacheinander IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 6
coolian Eclipse eclipse klappt nicht automatisch diese box aus mit vorschlägen IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 7
D Eclipse Automatisch Lambdas generieren IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 1
O Eclipse Pfad zur Java-Source ändert sich automatisch IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 4
M Eclipse Alle betroffenen Klassen automatisch öffnen? IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 2
S Eclipse: JUnit bei jedem Projekt automatisch hinzufügen lassen IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 7
G Eclipse Automatisch referenced jars importieren wenn Project im build path IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 3
T Neues Projekt automatisch in bestimmten repository IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 2
R Eclipse eclipse (serialVersionUID) automatisch neu generieren nach Änderung IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 4
Kr0e Eclipse Tool für Jars - Automatisch Dependencies einbinden IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 12
D Frage zu automatisch generierten Javacode IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 2
G NetBeans Perspektive automatisch umschalten IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 6
D Eclipse Wie ein NetBeans-Projekt automatisch in Eclipse importieren? IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 4
D Automatisch Interface implementieren - Parameternamen in Methoden nur arg0, etc.? IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 4
R Von VisualVM gesammelte Daten automatisch speichern IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 5
Unsympath Eclipse Eclipse zeigt keine Proposals und schließt Strings nicht automatisch IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 3
W Netbeans automatisch Einrücken IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 6
A NetBeans methoden automatisch beim übersetzen ausführen IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 7
Kasu Eclipse: Plugin, das Konsolenausgabe automatisch mitloggt? IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 4
reibi Eclipse - Classfiles ohne Source werden automatisch gelöscht IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 3
G Update auf NetBeans 6 automatisch? IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 2
P [Eclipse] Buildpath automatisch switchen IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 5
M Netbeans zwingt zum Überschreiben und importiert automatisch IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 4
M Eclipse oder Netbeans, automatisch Kommentar zufuegen IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 4
T Automatisch Java Klassen Generieren mit Modellbeschreibung IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 3
H Eclipse - automatisch kompilieren ausschalten IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 2
P klassen automatisch importieren in eclipse IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 12

Ähnliche Java Themen


Oben