Jak dodać opis do metody lub klasy

Question

Jak mogę dodać opis metody w Javie? Używam IDE NetBeans.

Answer 1

komentarze Zastosowanie javadoc -/** To jest komentarz */

Sprawdź ten link do szczegółowej dokumentacji http://en.wikipedia.org/wiki/Javadoc

Answer 2

Zobacz guide i spojrzeć na source code of some of the standard Java classes.

Answer 3

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.

Answer 4

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. :-)

Answer 5

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

Answer 6

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.