javadocを解析するときにチェックスタイルエラーが発生する

Question

私はゆっくりと既存のコードベースでjavadocsのcheckStyleチェックを導入しようとしています。

リストやマップなどを記述するパラメータ（@paramや@return）が出現するたびに発生するようです。コードを解析してエラーをスローします。 これを防ぐ方法は誰でも知り得ます??例えば

：

/** 
    * Process list of people. 
    * 
    * @param account the relevant account. 
    * @return List<People> the people we are interested in. 
    * @throws SQLException 
    */ 
    private static List<People> getPeople(Account account) throws SQLException {} 

ので、それは

* @return List<People> the people we are interested in. 

を解析し、エラーを作成することはできません。

error: Javadoc comment at column 18 has parse error. Missed HTML close tag 'People'. Sometimes it means that close tag missed for one of previous tags. 

異なるチェックを適用しようとするときに発生し、このjdocはありません/小切手を渡す必要があります。

すべてのヘルプは、おそらくそれは<と>のように、XMLタグとはみなされないよう<と>をエスケープする必要があり:)

Answer 1

Javadoc specificationによると、@returnには戻り値の型は含まれていません。 @returnの後に返される内容の説明を追加するだけです。そのタイプを含める場合は、それは説明の一部であるため、<などのHTML文字をエスケープする必要があります（>）。

@return {@link List} of {@link People} 

（あなたはパラメータ化された型にリンクすることはできませんが、代わりに、ジェネリック型とパラメータの型の両方にリンクする必要があります）：より良いオプションがようなものになるだろう。

Answer 2

素晴らしいことです。この質問も参照してくださいHow can I use "<" and ">" in javadoc without formatting?