Java
javadoc

Javadocコメントで不等号を書く方法

JavadocコメントにはHTMLタグが使用できるので、不等号をそのまま書くとタグとして認識されてしまいます。

悪い例

<ユーザー><ユーザーID, ユーザー>がHTMLタグとして認識されてしまいます。

/**
 * ユーザーリストをユーザーマップに変換します。
 * @param list ユーザーリスト<ユーザー>
 * @return ユーザーマップ<ユーザーID, ユーザー>
 */
private Map<String, User> toMap(List<User> list){
    ...
}

良い例

コードの場合

{@code }で囲むことで、その部分がコード扱いになり、そのまま表示されます。

/**
 * ユーザーリストをユーザーマップに変換します。
 * @param list ユーザーリスト{@code <ユーザー>}
 * @return ユーザーマップ{@code <ユーザーID, ユーザー>}
 */
private Map<String, User> toMap(List<User> list){
    ...
}

コードではない場合

{@literal }で囲むことで、その部分がそのまま表示されます。

/**
 * この数値が2つの数値の間にあるかどうかを判定します。
 * @param a
 * @param b
 * @return {@literal a < this < b}であればtrue, それ以外はfalse
 */
private boolean isBetween(int a, int b){
    ...
}

参考リンク