如果超类有文档,请忽略丢失的文档 [英] Ignore missing documentation if superclass has documentation

查看:177
本文介绍了如果超类有文档,请忽略丢失的文档的处理方法,对大家解决问题具有一定的参考价值,需要的朋友们下面随着小编来一起学习吧!

问题描述

有没有办法告诉SonarQube,如果覆盖的方法被记录在案,不要将重要的方法计入公开记录的api统计数据?由于以下情况,SonarQube发现许多缺少注释的方法。




$ b $我知道有一个注释忽略了SonarQube的某些规则,但是我们不想为我们的项目添加代码,以满足SonarQube。

解决方案

您可以使用继承文档。

  / ** 
* {@ inheritDoc}
* /
@Override


Is there any way to tell SonarQube not to count an overriding method into the public documented api statistics if the overridden method is documented? SonarQube finds many methods lacking annotation due to the case below.

I know there is an annotation to ignore certain rules of SonarQube, however we don't want to add code to our project in order to satisfy SonarQube.

解决方案

You could use inherit doc.

/**
 * {@inheritDoc}
 */
@Override

这篇关于如果超类有文档,请忽略丢失的文档的文章就介绍到这了,希望我们推荐的答案对大家有所帮助,也希望大家多多支持IT屋!

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