java注释html警告,Javadoc中允许的HTML标记

mernst..

30

从Java 8开始,Javadoc仅允许HTML标记的子集.

Javadoc的doclint组件强制执行此限制.您可以通过传递-Xdoclint:none给javadoc 来禁用所有doclint警告,但是您应该考虑修复Javadoc注释,否则生成的HTML API文档可能看起来很糟糕或者可能会忽略内容.(我经常使用

-Xdoclint:all,-missing除了丢失Javadoc @标签之外的所有内容的警告.)

我没有找到doclint允许的标签的公共文档,但是这里是一个允许的HTML标签列表,我从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

JDK 9的更新

JDK 9允许使用与JDK 8不同的一组标记.以下是两个JDK的标记列表,其中包含仅有一个JDK允许的标记.同样,数据来自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