La regola Checkstyle JavadocStyle non consente il tag <u>. Secondo i documenti, i controlli sono stati modellati dopo i controlli effettuati dal doclet DocCheck disponibile da Sun. Sfortunatamente, non ho trovato DocCheck da nessuna parte. Né ho trovato alcuna documentazione ufficiale sui tag HTML consentiti in Javadoc. C'è qualche?Tag HTML consentiti in Javadoc
Non ci sono restrizioni reali sull'utilizzo dell'HTML nei commenti Javadoc. Gli stati Javadoc documentation:
I commenti sono scritti in HTML: il testo deve essere scritto in HTML, in quanto devono utilizzare entità HTML e possono utilizzare tag HTML. È possibile utilizzare qualsiasi versione di HTML supportata dal browser; abbiamo scritto il doclet standard per generare codice conforme a HTML 3.2 altrove (al di fuori dei commenti della documentazione) con l'inclusione di fogli di stile e frame a cascata. (Si premette ogni file generato con "HTML 4.0" per i set di frame.)
L'elenco dei tag HTML consentito è hardcoded nel controllo di JavadocStyle Checkstyle (verificato, cercando in sorgenti Checkstyle 5.6). Quindi, se vuoi mantenere il controllo per le sue altre buone proprietà, dovrai convivere con il set limitato di tag HTML. Una soluzione per il problema sottolineatura è quello di usare i CSS (che è consentito) come questo: solo
<span style="text-decoration:underline;">underlined text</span>
Javadoc permette un sottoinsieme di tag HTML, come di Java 8.
componente doclint di Javadoc applica questa restrizione. È possibile disabilitare tutti gli avvisi doclint passando -Xdoclint:none a javadoc, , anche se si dovrebbe prendere in considerazione la possibilità di correggere i commenti Javadoc perché in caso contrario la documentazione dell'API HTML generata potrebbe sembrare scadente o potrebbe omettere il contenuto. (Io di solito uso -Xdoclint:all,-missing per ottenere avvertimenti su tutto, tranne che manca Javadoc @ tag.)
non ho trovato la documentazione pubblica dei tag che doclint permessi, ma ecco un elenco delle sue tag HTML consentito, che ho raccolte da File di Java 8 langtools/src/share/classes/com/sun/tools/doclint/HtmlTag.java.
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
Aggiornamento per JDK 9
JDK 9 consente un diverso insieme di tag di JDK 8 fa. Ecco un elenco di tag per entrambi i JDK, con note su quelli consentiti da uno solo dei JDK. Anche in questo caso, i dati provengono dal file 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
Cordiali saluti, l'elemento '' è stato esplicitamente aggiunto all'elenco hardcoded dei tag in Checkstyle 5.8. L'elenco non può ancora essere modificato, ma questo particolare problema è risolto. –