32

Checkstyle ルールJavadocStyleはタグを許可しません<u>。ドキュメントによると、チェックは、Sun から入手可能な DocCheck ドックレットによって行われたチェックの後にパターン化されました。残念ながら、DocCheck はどこにも見つかりませんでした。Javadoc で許可されている HTML タグに関する公式ドキュメントも見つかりませんでした。ありますか?

4

2 に答える 2

20

Javadoc コメントでの HTML の使用には、実質的な制限はありません。Javadoc ドキュメントには次のように記載されています。

コメントは HTML で記述されます - テキストは、HTML エンティティを使用する必要があり、HTML タグを使用できるという点で、HTML で記述する必要があります。ブラウザがサポートしている HTML のどのバージョンでも使用できます。カスケード スタイル シートとフレームを含めて、HTML 3.2 準拠のコードを別の場所 (ドキュメント コメント以外) に生成する標準ドックレットを作成しました。(フレーム セットのため、生成された各ファイルの前に「HTML 4.0」を付けます。)

許可された HTML タグのリストは、JavadocStyle Checkstyleチェックでハードコーディングされています (Checkstyle 5.6 のソースを参照して確認してください)。したがって、他の優れた特性をチェックし続けたい場合は、制限された HTML タグのセットを使用する必要があります。下線の問題の 1 つの回避策は、次のように (許可されている) CSS を使用することです。

<span style="text-decoration:underline;">underlined text</span>
于 2013-05-12T21:52:28.990 に答える