Javadocの@see

2020-04-15

こんなコメントを書いておりました。

class Hoge {
    /**
     * return greeting message string.
     *
     * @see https://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html
     * @return greeting message string
     */
    public String hello() {
        return "Hi";
    }
}

@seeの使い方を間違ってます。
正しくは次のようにhtmlタグが必要。

/**
 * @see <a href="https://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html#CHDDIEDI">javadoc</a>
 */

@seeというアノテーションの使い勝手がいいので、wikiやらメモでも「確認すること」の意味で、@see http://〜なんて書いてました。そしていつの間にかコードにも……

参考 #

Form 2.の箇所: https://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html#CHDDIEDI