エンジニアのためのJavadoc再入門講座を読んだ。Javadocいろいろ知らなかったなーってことを再確認。Javadocだけじゃなく、ドキュメンテーションコメントを書くとき(Scaladocとか)でも気をつけた方がいいことが色々あったのでまとめておく。 Javadocタグを使いこなす ブロックタグとインラインタグがある。ブロックタグは @param のように単体で何らかの概念を表現し、行頭に配置しないといけない。インラインタグは主説明やタグセクション内部で特定の部分をマークアップするために使う。 インラインタグ @literal 特殊な文字をエスケープする。 {@literal List<String>} のように書くと、<などのエスケープが必要な文字をそのまま書ける。 @code コードをコードとして整形する。{@code ~~~~ } でサンプルコードが書ける。 @link 他のクラスやメソッドに対してリンクを張る。