メソッドまたはクラスに説明を追加する方法

Question

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

Answer 1

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

メソッドの場合、基本的には

/**
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定義を探していると思います。したがって、プロジェクトで使用されているライブラリにソースをアタッチする必要があります。

Answer 7

@Description("method name")
methodName<String> getset(){...}

@Description("class name")
class ClassName{..}