Jak mogę dodać opis metody w Javie? Używam IDE NetBeans.Jak dodać opis do metody lub klasy
Odpowiedz
komentarze Zastosowanie javadoc -/** To jest komentarz */
Sprawdź ten link do szczegółowej dokumentacji http://en.wikipedia.org/wiki/Javadoc
Zobacz guide i spojrzeć na source code of some of the standard Java classes.
Pisanie Uwagi powyższe metodę powinien robić to, co chcesz Przykład:
/**
This method does some serious stuff
*/
public int getN()
{
return n;
}
Jeśli używasz Javadocs powinien być opis metody.
Wszystko tutaj: http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/index.html.
Dodaję to zdanie, ponieważ moja odpowiedź powyżej jest zbyt krótka dla SO. :-)
Można użyć Javadocs używając/** * Uwagi/
na sposób w zasadzie można mieć
/**
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
*/
Można użyć tego linku w celu uzyskania dalszych pomoc http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#descriptions
I załóżmy, że IDE szuka definicji javadoc w plikach źródłowych. Dlatego musisz dołączyć źródła do bibliotek używanych w projekcie.
Nie wierzę, że zadajesz to pytanie :-)? – AmitG