Javadocで許可されるHTMLタグ

Question

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

Answer 1

JavadocコメントでのHTMLの使用には実質的な制限はありません。 Javadoc documentation状態：

コメントはHTMLで書かれている - テキストはその中で彼らは、HTMLエンティティを使用する必要がありますし、HTMLタグを使用することができ、HTMLで記述する必要があります。 ブラウザでサポートされているHTMLのバージョンを使用できます。カスケーディングスタイルシートとフレームが含まれたHTML 3.2準拠のコードを他の場所（ドキュメンテーションコメントの外）で生成するための標準ドックレットを作成しました。 （私たちがあるため、フレームセットの「HTML 4.0」と、それぞれ生成されたファイルを前置き。）

許可HTMLタグのリストは、（Checkstyleは5.6のソースを見て、検証）JavadocStyle Checkstyleチェックにハードコードされています。したがって、他の優れたプロパティのチェックを続けたい場合は、制限されたHTMLタグセットを使用する必要があります。

のJavadocのdoclintコンポーネントはこの制限を強制するJava 8のように、HTMLタグのサブセットのみ

<span style="text-decoration:underline;">underlined text</span> 

Answer 2

のJavadoc許可：下線の問題の1つの回避策は、このように（許可されている）CSSを使用することです。 -Xdoclint:noneをjavadoc、 に渡すことで、すべてのdoclint警告を無効にすることができます。そうしないと、生成されたHTML APIドキュメントが見栄えが悪くなったり、コンテンツが省略される可能性があります。 （私は通常のJavadoc @タグが欠落している以外のすべてについての警告を取得するために -Xdoclint:all,-missingを使用しています。）

私は許可をdoclintタグの公開文書を発見していないが、ここで私はから収集、その許可されたHTMLタグのリストは、ありますJava 8のファイルlangtools/src/share/classes/com/sun/tools/doclint/HtmlTag.java。 JDK 9

JDK 9用

A 
B 
BIG 
BLOCKQUOTE 
BODY 
BR 
CAPTION 
CENTER 
CITE 
CODE 
DD 
DFN 
DIV 
DL 
DT 
EM 
FONT 
FRAME 
FRAMESET 
H1 
H2 
H3 
H4 
H5 
H6 
HEAD 
HR 
HTML 
I 
IMG 
LI 
LINK 
MENU 
META 
NOFRAMES 
NOSCRIPT 
OL 
P 
PRE 
SCRIPT 
SMALL 
SPAN 
STRONG 
SUB 
SUP 
TABLE 
TBODY 
TD 
TFOOT 
TH 
THEAD 
TITLE 
TR 
TT 
U 
UL 
VAR 

アップデートはJDK 8が行うよりも、タグの異なるセットを許可します。ここには、両方のJDKのタグのリストと、JDKの1つのみによって許可されているタグに関する注意事項が記載されています。再び、データはHTMLTag.javaファイルから得られます。

A 
BIG  // JDK 8 only 
B   // JDK 8 only 
BLOCKQUOTE 
BODY 
BR 
CAPTION 
CENTER 
CITE  // JDK 8 only 
CODE 
DD 
DFN  // JDK 8 only 
DIR  // JDK 9 only 
DIV 
DL 
DT 
EM 
FONT 
FOOTER // JDK 9 only 
FRAME  // JDK 8 only 
FRAMESET // JDK 8 only 
H1 
H2 
H3 
H4 
H5 
H6 
HEAD 
HEADER  // JDK 9 only 
HR 
HTML 
I 
IFRAME  // JDK 9 only 
IMG 
INPUT  // JDK 9 only 
LI 
LINK 
LISTING // JDK 9 only 
MAIN  // JDK 9 only 
MENU 
META 
NAV  // JDK 9 only 
NOFRAMES // JDK 8 only 
NOSCRIPT 
OL 
P 
PRE 
SCRIPT 
SECTION  // JDK 9 only 
SMALL 
SPAN 
STRONG 
SUB 
SUP   // JDK 8 only 
TABLE 
TBODY 
TD 
TFOOT  // JDK 8 only 
TH 
THEAD  // JDK 8 only 
TITLE 
TR 
TT 
U   // JDK 8 only 
UL 
VAR   // JDK 8 only