İzin verilen HTML etiketleri Javadoc'ta

Question

Checkstyle kuralı JavadocStyle, <u> etiketine izin vermez. Dokümanlara göre, DocCheck doclet'in Sun'dan temin ettiği kontrollerden sonra çekler düzenlenmiştir. Maalesef, DocCheck'i hiçbir yerde bulamadım. Javadoc'ta izin verilen HTML etiketleri hakkında herhangi bir resmi doküman bulunamadı. Var mı

Answer 1

Javadoc yorumlarında HTML kullanımıyla ilgili hiçbir gerçek kısıtlama yoktur. Javadoc documentation devletler:

Yorumlar HTML yazılır - Metin ki onlar HTML öğelerini kullanmalıdır ve HTML etiketlerini kullanabilirsiniz, HTML ile yazılmış olmalıdır. Tarayıcınızın desteklediği HTML sürümünü kullanabilirsiniz., standart doclet'i, basamaklı stil sayfalarının ve çerçevelerin eklenmesiyle (dokümantasyon yorumlarının dışında) başka bir yerde HTML 3.2 uyumlu kod oluşturmak için yazdık. (Nedeniyle çerçeve kümelerinin "HTML 4.0" ile her Oluşturulan dosyayı önsöz.)

(Checkstyle 5.6 kaynağa bakarak doğrulanmadı) izin HTML etiketleri listesini JavadocStyle Checkstyle kontrol altında kodlanmış 'dir. Bu yüzden, diğer iyi özelliklerini kontrol etmek istiyorsanız, kısıtlı HTML etiketleriyle yaşamak zorunda kalacaksınız. Javadoc en doclint bileşeni bu kısıtlamayı zorlar

Java 8. itibariyle HTML etiketleri

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

Answer 2

Javadoc izinleri yalnızca bir alt kümesini: altı çizili soruna yönelik bir geçici çözüm böyle (izin verilir) CSS kullanmaktır. Tüm doclint uyarılarını -Xdoclint:none'u javadoc, 'a aktararak devre dışı bırakabilirsiniz; ancak Javadoc yorumlarınızı düzeltmeyi düşünmeniz gerekir, aksi halde oluşturulan HTML API belgeleri kötü görünebilir veya içeriği atlayabilir.

Ben izin doclint etiketlerin kamu belgelerine bulamadı (Ben genellikle. JavaDoc'u @ etiketleri eksik dışında her konuda uyarılar almak için -Xdoclint:all,-missing kullanın), ama burada panoda onun izin HTML etiketlerinin bir listesini sunan Java 8'in dosyası langtools/src/share/classes/com/sun/tools/doclint/HtmlTag.java. 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 

Güncelleme

JDK 9 JDK 8 yaptığından daha etiketleri farklı bir dizi izin verir. JDK'ların yalnızca biri tarafından izin verilenlerle ilgili notlar içeren, hem JDK'lar için etiketlerin listesi. Yine, veriler HTMLTag.java dosyasından gelir.

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