マークダウン形式Javadoc

• 概要
• マークダウン形式の例

• JEP 467: Markdown Documentation Comments
• JavaDoc Documentation Comment Specification for the Standard Doclet (JDK 23)
• CommonMark Spec …マークダウンの仕様
• 従来形式のJavadoc

    /**
     * 加算.
     *
     * <p>2つの値を加算する。</p>
     * <pre>
     * int r = add(1, 2);
     * </pre>
     *
     * @param arg1 加算する値
     * @param arg2 加算する値
     * @return 加算された値
     */
    public int add(int arg1, int arg2) {
        return arg1 + arg2;
    }

    /// 加算.
    ///
    /// 2つの値を加算する。
    ///
    /// ```
    /// int r = add(1, 2);
    /// ```
    ///
    /// @param arg1 加算する値
    /// @param arg2 加算する値
    /// @return 加算された値
    public int add(int arg1, int arg2) {
        return arg1 + arg2;
    }

    /**
     * <pre>
     * /* コメント1 */
     * // コメント2
     * </pre>
     */

Javaではコメントがネストできないので、
Javadocコメント内の「*/」でJavadocコメント全体の終了と認識されてしまう。

    /// 
    /// ```
    /// /* コメント1 */
    /// // コメント2
    /// ```
    ///

///で始める形式だと、「*/」は特に意味を持たないので問題ない。