7
Wie kann ich eine Methodenbeschreibung in Java hinzufügen? Ich benutze NetBeans IDE.So fügen Sie eine Beschreibung zur Methode oder Klasse hinzu
A
Antwort
14
Verwendung javadoc Kommentare -/** Dies ist ein Kommentar */
prüfen Link zur detaillierten Dokumentation http://en.wikipedia.org/wiki/Javadoc
3
die guide See und einen Blick auf die source code of some of the standard Java classes nehmen.
2
Schreiben Kommentare über Ihre Methode sollte das tun, was Sie Beispiel wollen:
/**
This method does some serious stuff
*/
public int getN()
{
return n;
}
Wenn Sie javadocs verwenden sollte die Beschreibung des Verfahrens sein.
2
Es ist alles hier: http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/index.html.
Ich füge diesen Satz hinzu, weil meine obige Antwort für SO zu kurz ist. :-)
7
können Sie javadocs mit nutzen/** * Kommentare/
Für ein Verfahren im Grunde kann man
/**
The Desciption of the method to explain what the method does
@param the parameters used by the method
@return the value returned by the method
@throws what kind of exception does this method throw
*/
haben Sie diesen Link für weitere Hilfe http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#descriptions
2
ich verwenden kann, Angenommen, die IDE sucht nach den Javadoc-Definitionen in den Quelldateien. Daher müssen Sie die Quellen an die im Projekt verwendeten Bibliotheken anhängen.
Ich glaube nicht, dass Sie diese Frage stellen :-)? – AmitG