JavaDoc コメントにおける複数行コード例の説明

JavaDoc コメントは、Java コード内のクラス、メソッド、フィールドなどの要素に対するドキュメンテーションを提供するものです。これら要素の用途、引数、戻り値、例外などを説明するために使用されます。

複数行コード例は、JavaDoc コメント内にコードのサンプルを記述する機能です。これにより、メソッドの使用方法やコードの動作をより明確に示すことができます。

複数行コード例の書き方

1. Javadoc コメントブロックの開始
   

   /**
    * ...
    */
   

2. 複数行コードの記述
   

   /**
    * This method demonstrates how to use the `myMethod` method.
    *
    * ```java
    * String result = myMethod("Hello", "World");
    * System.out.println(result);
    * ```
    */
   

   • ````java` タグを使用してコードブロックを囲みます。

/**
 * This class represents a simple calculator.
 */
public class Calculator {

    /**
     * Adds two numbers.
     *
     * @param a the first number
     * @param b the second number
     * @return the sum of the two numbers
     */
    public int add(int a, int b) {
        return a    + b;
    }

    /**
     * This method demonstrates how to use the `add` method.
     *
     * ```java
     * Calculator calculator = new Calculator();
     * int result = calculator.add(5, 3);
     * System.out.println("The result is: " + result);
     * ```
     */
    public void main(String[] args) {
        // ...
    }
}

HTML タグの使用

JavaDoc コメントでは、HTML タグを使用してコードの書式をカスタマイズすることもできます。例えば、<pre> タグを使用してコードをインデント付きで表示することができます。

/**
 * This method demonstrates how to use the `myMethod` method.
 *
 * <pre>
 * String result = myMethod("Hello", "World");
 * System.out.println(result);
 * </pre>
 */

/**
 * This class represents a simple calculator.
 */
public class Calculator {

    /**
     * Adds two numbers.
     *
     * @param a the first number
     * @param b the second number
     * @return the sum of the two numbers
     */
    public int add(int a, int b) {
        return a    + b;
    }

    /**
     * This method demonstrates how to use the `add` method.
     *
     * ```java
     * Calculator calculator = new Calculator();
     * int result = calculator.add(5, 3);
     * System.out.println("The result is: " + result);
     * ```
     */
    public void main(String[] args) {
        // ...
    }
}

/**
 * This method demonstrates how to use the `myMethod` method.
 *
 * <pre>
 * String result = myMethod("Hello", "World");
 * System.out.println(result);
 * </pre>
 */

Javadoc コメントブロックの開始:

/**
 * ...
 */

複数行コードの記述:

/**
 * This method demonstrates how to use the `myMethod` method.
 *
 * ```java
 * String result = myMethod("Hello", "World");
 * System.out.println(result);
 * ```
 */

/**
 * This method demonstrates how to use the `myMethod` method.
 *
 * <pre>
 * String result = myMethod("Hello", "World");
 * System.out.println(result);
 * </pre>
 */

コードブロックのインデント:

/**
 * This method demonstrates how to use the `myMethod` method.
 *
 *     String result = myMethod("Hello", "World");
 *     System.out.println(result);
 */

コードコメントの活用:

/**
 * This method demonstrates how to use the `myMethod` method.
 *
 * The following code snippet shows an example usage:
 *
 * // Code example starts here
 * String result = myMethod("Hello", "World");
 * System.out.println(result);
 * // Code example ends here
 */

外部ファイルへのコード参照:

/**
 * This method demonstrates how to use the `myMethod` method.
 *
 * Please refer to the `example.txt` file for a code example.
 */

コード生成ツール:

/**
 * This method demonstrates how to use the `myMethod` method.
 *
 * Generated code example:
 *
 * ```java
 * // Code generated automatically
 * String result = myMethod("Hello", "World");
 * System.out.println(result);
 * ```
 */