1. ホーム
  2. java

[解決済み] /* ...*/ と /** ...*/ の違いは何ですか?*/

2022-02-01 12:25:02

質問

Eclipseはコメントに対して異なるフォーマットを印刷することに気づきました。

/* Eclipse prints it in green 
*/

とか書けば。

/** Eclipse prints it in blue
*/

この2種類のコメントの違いは何ですか?

どのように解決するのですか?

/* 
* It is multi-line comment in Java
*
*/

/** 
* It is a Javadoc. Can be found above methods and Class definitions.
*
*
*/

以下はその抜粋です。 ウィキペディア Javadocに関して。

<ブロッククオート

Javadoc のコメントは、標準的な複数行のコメントによってコードから分離されます。 というタグがあります。開始タグ(begin-comment delimiterと呼ばれます)には のようにアスタリスクを追加します。

The first paragraph is a description of the method documented.
Following the description are a varying number of descriptive tags, signifying:
    The parameters of the method (@param)
    What the method returns (@return)
    Any exceptions the method may throw (@throws)
    Other less-common tags such as @see (a "see also" tag)

クラスレベルのJavadocの例。

/**
 * @author      Firstname Lastname <address @ example.com>
 * @version     1.6                 (current version number of program)
 * @since       2010-03-31          (the version of the package this class was first added to)
 */
public class Test {
    // class body
}

メソッドレベルのJavadocの例。

/**
 * Short one line description.                           
 * <p>
 * Longer description. If there were any, it would be    
 * here.
 * <p>
 * And even more explanations to follow in consecutive
 * paragraphs separated by HTML paragraph breaks.
 *
 * @param  variable Description text text text.          
 * @return Description text text text.
 */
public int methodName (...) {
    // method body with a return statement
}