java - メソッドやクラスに説明を追加する方法

Question

Java でメソッドの説明を追加するにはどうすればよいですか? NetBeans IDE を使用しています。

Answer 1

/** コメントを使用して Javadoc を使用できます */

基本的にあなたが持つことができる方法について

/**
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
*/

このリンクを使用して、さらにヘルプを得ることができますhttp://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#descriptions

Answer 2

javadoc コメントを使用 - /** これはコメントです */

詳細なドキュメントについては、このリンクを確認してくださいhttp://en.wikipedia.org/wiki/Javadoc

Answer 3

メソッドの上にコメントを書くと、あなたが望むことをするはずです例：

/** 
This method does some serious stuff 
*/
public int getN()
{
return n;
}

javadocs を使用する場合は、メソッドの説明にする必要があります。

Answer 4

ガイドを参照し、いくつかの標準Javaクラスのソースコードを確認してください。

Answer 5

すべてここにあります: http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/index.html。

上記の私の答えは SO には短すぎるため、この文を追加します。:-)

Answer 6

IDE がソース ファイル内の javadoc 定義を探していると思います。したがって、プロジェクトで使用されるライブラリにソースを添付する必要があります。