图 7:javadoc 进阶标签(下)(1080×1440 速查卡片)
标签速查表
- {@link} — 插入一个到另一个主题的链接。示例:
{@link name text} - {@linkplain} — 插入链接,但显示纯文本字体(不加等宽/代码样式)
- {@docRoot} — 指明当前文档根目录的路径
- {@inheritDoc} — 从直接父类继承的注释
- {@value} — 显示常量的值,该常量必须是 static 属性
- @serial — 说明一个序列化属性
- @serialData — 说明通过 writeObject() 和 writeExternal() 方法写的数据
- @serialField — 说明一个 ObjectStreamField 组件
- @deprecated — 指名一个过期的类或成员
关键区别
- {} 花括号标签(如 {@link}):能嵌在句子中间,作为行内元素使用
- @ 块标签(如 @param):必须独占一行开头,或紧跟星号 *