JDK 10的摘要Javadoc标签
JDK 10通过发行JDK-8173425 引入了Javadoc标签{@summary}
(“ Javadoc需要一个新标签来指定摘要。”)。 这个新标签允许开发人员显式指定Javadoc注释的哪些部分出现在“摘要”中,而不是依靠Javadoc的默认处理来寻找一个时间和空间来划定注释的摘要部分的结尾。 JDK-8173425指出:“当前在javadoc中,元素的摘要(第一句)由点空间规则或需要时使用BreakIterator解密。” 它补充说,知道隐式选择的摘要句子将是什么可能会令人困惑。
查看{@summary}
的最简单方法可能是通过Javadoc示例。 下一个代码清单显示了四种具有类似Javadoc注释的方法,两种使用显式的{@summary}
标记,两种依赖于隐式的Javadoc摘要构造。
在Javadoc方法注释中展示{@summary}
package dustin.examples.javadoc;/*** Demonstrate JDK 10 added summary support. Demonstrates* this by comparing similar methods' Javadoc comments with* and without use of new "@summary" tag.*/
public class Summary
{/*** This method's first sentence is normally in the summary.* Here are some of its characteristics:* <ul>* <li>This method does great things.</li>* <li>This method does not really do anything.</li>* </ul>*/public void implicitSummary1(){}/*** This method's first sentence is normally in the summary.Here are some of its characteristics:* <ul>* <li>This method does great things.</li>* <li>This method does not really do anything.</li>* </ul>*/public void implicitSummary2(){}/*** {@summary This method's first sentence is normally in the summary.* Here are some of its characteristics:* <ul>* <li>This method does great things.</li>* <li>This method does not really do anything.</li>* </ul>}*/public void explicitSummary1(){}/*** {@summary This method's first sentence is normally in the summary.Here are some of its characteristics:* <ul>* <li>This method does great things.</li>* <li>This method does not really do anything.</li>* </ul>}*/public void explicitSummary2(){}
}
当针对此简单类执行第一个JDK 10(18.3)Release Candidate(内部版本43)附带的Javadoc工具时,在Web浏览器中生成HTML的“ Method Summary ”部分如下所示。
将HTML输出与上面的注释Java代码进行比较,演示了{@summary}
如何允许对方法摘要中出现的内容进行显式控制。
翻译自: https://www.javacodegeeks.com/2018/02/jdk-10s-summary-javadoc-tag.html
JDK 10的摘要Javadoc标签相关推荐
- jdk10 换成jdk8_JDK 10的摘要Javadoc标签
jdk10 换成jdk8 JDK 10通过发行JDK-8173425 引入了Javadoc标签{@summary} (" Javadoc需要一个新标签来指定摘要."). 这个新标签 ...
- jdk 5 到 jdk 10各个版本的新特性
jdk5 jdk10各个版本的新特性 JDK1.5新特性: 工程代号为Tiger(老虎) 自从JDK1.3开始,sun维持一个习惯,大约每隔两年发布一个JDK的主版本,以动物命名,期间发布的各个修正版 ...
- java -d32_java11教程--JDK 10删除和不推荐的功能和选项-2
工具/ javadoc(工具) 删除旧的(JDK 6,JDK 7和JDK 8 Era)标准Doclet 在此发行版中已删除了旧的(JDK 6,JDK 7和JDK 8时代)标准doclet,该标准doc ...
- JDK 10 的 109 项新特性
来源:开源中国, www.oschina.net/translate/109-new-features-in-jdk-10 虽然感觉 JDK9 发布才仅仅几周的时间,然而,随着新的 OpenJDK 的 ...
- 第一个JDK 10(18.3)候选版本(内部版本43)展示了新的版本控制方案
Mark Reinhold的帖子" JDK 10:First Release Candidate "宣布"在build 43中没有未解决的P1错误",并将Bui ...
- jdk 1.8 不可变常量_在JDK 10中不可变与不可修改
jdk 1.8 不可变常量 大约两个月前, 斯图尔特·马克斯 ( Stuart Marks)写道:" 不变性就像葡萄酒 ." 然后,他提醒读者注意叔本华的熵定律 :"如果 ...
- javadoc 标签_新的Javadoc标签@ apiNote,@ implSpec和@implNote
javadoc 标签 如果您已经在使用Java 8,则可能会看到一些新的Javadoc标签: @apiNote , @implSpec和@implNote . 他们怎么了? 如果要使用它们,该怎么办? ...
- 首个JDK 10(18.3)发行候选版(内部版本43)展示了新的版本控制方案
Mark Reinhold的帖子" JDK 10:First Release Candidate "宣布"内部版本43中没有未解决的P1错误",并将Build ...
- JDK 10:FutureTask获取一个toString()
我已经有很长时间了,对于大多数具有独特属性的Java类,开发人员应该花时间重写Object.toString() ,即使它只是通过IDE生成的实现或使用诸如Apache之类的库类来实现Commons ...
最新文章
- CentOS---网络配置详解
- 《剑指offer》删除链表中重复的节点
- What is 测试金字塔?
- 原 jQuery基础修炼圣典—DOM篇
- Struts2标签-checkbox只读属性设置
- C++练习题(数组1)
- Cannot detect Web Project version. Please specify version of Web Project through Maven project ...报错
- 必收藏的九大塑料注塑成型技术及其特点
- namesilo修改域名服务器,Namesilo 域名设置 A记录
- 用opengl画一个3D机器人 完整源码 直接使用
- 北京理工大学本科毕业论文答辩和论文选题PPT模板
- ProcessOn第一次使用教程
- MySQL导入百万数据实践
- 【计算机科学】【2013.08】点云的表面重建
- 2022年恒生指数研究报告
- Android社招最全面试题,成功拿下大厂offer
- HEVC/H.265面试问题准备(PART 3. 环路滤波+熵编码)
- 塔罗牌第五张是什么牌_塔罗占卜你是一个什么样的人?
- 2013全国计算机一级考试,2013全国计算机等级考试一级试题及讲解
- Java并发编程——this引用逸出(this Escape)