Best Practice für JavaDocs - Interface,Umsetzung oder Beides?
Ich habe eine DAO-Schnittstelle und die Implementierung des DAO. Die JavaDocs in der Schnittstelle sind, was Netbeans zeigt der client die Implementierung der DAO-Methoden.
Natürlich werde ich halten müssen, um die JavaDocs in das interface. Aber was ist mit der Umsetzung? Auf der einen Seite ist es bequem haben Sie es, aber auf der anderen Seite, es ist Nachahmung, und verlangt, dass Sie gepflegt werden, an zwei stellen.
Nur Fragen, was andere Java-Entwickler tun.
InformationsquelleAutor EdgeCase | 2012-07-26
Du musst angemeldet sein, um einen Kommentar abzugeben.
In mein Projekt mit Eclipse erstellt automatisch die Dokumentation wie folgt :
Haben wir erstellt javadoc mit Hilfe von Ant-task, so schafft es link zu der Schnittstelle.
InformationsquelleAutor Nandkumar Tekale
Wenn die Umsetzung der Methode nicht bieten eigene Javadoc, da wird noch ein link zu der interface-Methode docs. Ich habe nie verstanden, warum Eclipse fügt
/* (non-Javadoc) @see ... */
als die Javadocs wird automatisch ein Verweis auf die Schnittstelle docs.Beispiel:
Nach dem ausführen
javadoc
,Thing.getName
's Javadocs sind:Die meisten IDEs (Eclipse) hat einen link zu gehen, um die Definition der Schnittstelle/Klasse
InformationsquelleAutor Steve Kuo
Das interface sollte alle Informationen über den Vertrag, im Grunde, was die Methode macht, die Beschreibung der Parameter, Rückgabewerte und so weiter.
Sei denn, es gibt einige zusätzliche Informationen, die nicht klar aus der Beschreibung des interface (gibt es selten ist), die Dokumentation für die Implementierung sollten dann einfach eine Verknüpfung zu der interface-Methode.
Dies ist das format, das ich gefunden habe, die meisten brauchbaren sowohl die Implementierung und die client-Seite des Zauns.
InformationsquelleAutor biziclop