新的javadoc注解@apiNote [英] New javadoc annotation @apiNote

查看:65
本文介绍了新的javadoc注解@apiNote的处理方法,对大家解决问题具有一定的参考价值,需要的朋友们下面随着小编来一起学习吧!

问题描述

我在LongStream类文档中发现了一个新的未记录的javadoc标记。Javadoc标记@apiNote似乎用于详细说明方法,但没有关于该标记的文档或发行说明。

它的真正目的是什么?其文档在哪里?

Reduce method documentation

中可以找到使用@apiNote编译的javadoc示例

推荐答案

如果不是标准的,我会说他们现在是官方的。请参见JDK-8068562。正如Nicolai上面指出的,他的博客文章New Javadoc Tags @apiNote, @implSpec and @implNote给出了一个很好的概述。它们是supported by Netbeanssupported by IntelliJsupported by Eclipse。它们在Efficient Java第三版中进行了讨论和推荐。它们在整个核心Java库源代码中使用。

这篇关于新的javadoc注解@apiNote的文章就介绍到这了,希望我们推荐的答案对大家有所帮助,也希望大家多多支持IT屋!

查看全文
登录 关闭
扫码关注1秒登录
发送“验证码”获取 | 15天全站免登陆