Antwort
 
Themen-Optionen Thema durchsuchen
Alt 12.09.2005, 14:54 Nach oben    #1
Erfahrener Benutzer
 
Registriert seit: 28.08.2004
Ort: konstanz am bodensee
Beiträge: 190
Standard klassen dokumentation automatisieren

hello again,
ich habe eine größere ansammlung von selbstgeschriebenen klassen,
die ich mit javadoc kommentaren ausstatten will,
war wohl am anfang zu faul kommentaren zu schreiben...

jetzt möchte ich mir die arbeit machen und alle funktionen dokumentieren...
aber natürlich so einfach wie möglich .
also meine frage, gibt es ein tool mit dem man für eine angegebene menge
von klassen javadoc tags erzeugen kann?

ein methoden kommentar sieht z.b. so aus
Code:
/** initiates multilang support and sets a specified language base dir and a default language
  * @param String baseDir - base dir for all language files
  * @param String defaultLanguage - default language
  * **/
wenn man das jetzt für jede methode in jeder klasse selbst schreiben muss ist das ziemlich viel arbeit...
nützlich währe es hier wenn man die gerüste, automatisch erzeugen könnte

Code:
/** 
  * @param String 
  * @param String 
  * **/
dieser teil automatisch erzeugt würde schonmal viel schreibarbeit (copy&paste) übernehmen.
auch eine funktion jede klasse eine einheitlichen header hinzufügen zu können währe hilfreich...

mfg beny
beny_mcde ist offline  
Diesen Beitrag zu to del.icio.us hinzufügen!Diesen Beitrag zu Technorati hinzufügen!Diesen Beitrag zu Mister Wong hinzufügen!
Mit Zitat antworten
Alt 13.09.2005, 08:47 Nach oben    #2
ehli75
Gast
 
Beiträge: n/a
Standard

Nimm doch einfach Eclipse dafür. wenn du in der Zeile über deiner Methode /** schreibst + Enter, wird automatisch genau so vervollständigt, wie du es haben willst.
 
Diesen Beitrag zu to del.icio.us hinzufügen!Diesen Beitrag zu Technorati hinzufügen!Diesen Beitrag zu Mister Wong hinzufügen!
Mit Zitat antworten
Alt 13.09.2005, 13:23 Nach oben    #3
Erfahrener Benutzer
 
Registriert seit: 28.08.2004
Ort: konstanz am bodensee
Beiträge: 190
Standard

nice... mal wieder liegt die lösung ganz nah...
seit eclipse 3.1 habe ich netbeans verlasen, aber das feature ist mir noch nicht aufgefallen.....

wie seht es aus mit dem klassenheader?
oder muss ich den einzeln in jede klasse einfügen?
es gibt ja sowas wie code templates, das funtzt aber ja nur wenn man eine neue klasse erstellt..
beny_mcde ist offline  
Diesen Beitrag zu to del.icio.us hinzufügen!Diesen Beitrag zu Technorati hinzufügen!Diesen Beitrag zu Mister Wong hinzufügen!
Mit Zitat antworten
Alt 14.09.2005, 19:10 Nach oben    #4
ehli75
Gast
 
Beiträge: n/a
Standard

Klar geht das für die Klassen auch ... einfach in der Zeile direkt über der klassendefinition "/**" + Enter ... und schon kommt ein kompletter Block daher. Da steht aber nur @author und TODO drin ... vielleicht kann man das ja irgendwo festlegen (bin ich mir ziemlich sicher das das geht).
Javadocs kann man für alles mögliche erzeugen lassen ... ahb grad mal probiert ... einfach die Variable, Methode, Klasse ... markieren, rechts Klick und dann unter Source "Add JavaDoc comment" auswählen ... und das war's.
 
Diesen Beitrag zu to del.icio.us hinzufügen!Diesen Beitrag zu Technorati hinzufügen!Diesen Beitrag zu Mister Wong hinzufügen!
Mit Zitat antworten
Alt 19.10.2005, 20:03 Nach oben    #5
Sesselkleber
 
Benutzerbild von sparrow
 
Registriert seit: 17.01.2005
Beiträge: 581
Standard

Hmm... gibt es diese Option eigentlich bei Eclipse 3.1 nicht mehr?
Bei mir gibt es nur noch "add comment", nicht "Add JavaDoc comment".
sparrow ist offline  
Diesen Beitrag zu to del.icio.us hinzufügen!Diesen Beitrag zu Technorati hinzufügen!Diesen Beitrag zu Mister Wong hinzufügen!
Mit Zitat antworten
Antwort

Lesezeichen


Aktive Benutzer in diesem Thema: 1 (Registrierte Benutzer: 0, Gäste: 1)
 
Themen-Optionen Thema durchsuchen
Thema durchsuchen:

Erweiterte Suche

Forumregeln
Es ist dir nicht erlaubt, neue Themen zu verfassen.
Es ist dir nicht erlaubt, auf Beiträge zu antworten.
Es ist dir nicht erlaubt, Anhänge hochzuladen.
Es ist dir nicht erlaubt, deine Beiträge zu bearbeiten.

BB-Code ist an.
Smileys sind an.
[IMG] Code ist an.
HTML-Code ist aus.
Trackbacks sind an
PingBacks sind an
RefBacks sind aus

Ähnliche Themen
Thema Autor Forum Antworten Letzter Beitrag
Klassen für Eingabeüberprüfungen ? Doggi PHP-Programmierung 15 31.01.2006 09:37
alle Klassen eines Packages ermitteln ehli75 Allgemeine Java-Programmierung 3 16.12.2005 13:30
PropertyChangeEvent etc. auch für Klassen, die keine Beans sind? NewYork Allgemeine Java-Programmierung 2 23.11.2005 00:07
Performanceeinbusen beim Laden von Klassen? Gottzilla Allgemeine Java-Programmierung 4 15.08.2005 02:08
MVC Programmierung nur mit Klassen mit UI Endung? Java17 Desktop-Applikationen und Grafik 5 14.03.2005 17:12


Alle Zeitangaben in WEZ +1. Es ist jetzt 00:47 Uhr.


Powered by vBulletin® Version 3.7.4 (Deutsch)
Copyright ©2000 - 2008, Jelsoft Enterprises Ltd.
Search Engine Optimization by vBSEO 3.2.0

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45