web-dev-qa-db-ja.com

Java like Java docs？

メソッドの上にマウスを置くと、Javaのメソッドの上にマウスを置くと、メソッドがどのように機能するかについてのドキュメントを表示できるようになります。/*** /がどのように行われるかはわかっていますが、次のようになります。

  1. Paramsの略をどのように説明しますか？

  2. どのように新しい行を作成しますか、または単語を太字または斜体にしますか？

javadocumentationjavadoc
15
Ofek Ron

EclipseをIDEとして使用している場合は、コメントを作成する必要があります。

/**

enterキーを押すと、パラメータや戻り値などを含むJavadocのコードが生成されます。説明を入力するだけです。

同じことがクラス宣言にも当てはまります（Javadocコメントは常に次の要素に関連しています）

注：

メソッドにドキュメントを添付するには、上部のコメントでメソッド名を指定する必要があります。

例えば

/**
 * create_instance
 * @param array of attributes for instance containing web, db, arrival_rate, response_time for instance 
 * respectively.
 * @return Instance object
 */
24
Peter Ilfrich

Paramsの略をどのように説明しますか？

使用する @param 鬼ごっこ：

/**
 * @param paramName Explanation of the param
 */
public void foo(String paramName);

どのように新しい行を作成しますか、または単語を太字または斜体にしますか？

標準のHTMLを使用します。つまり、<p></p>、<br/>、<strong>および<em>（または意味論的でない<b>および<i>）

23
Tomasz Nurkiewicz