当前位置: 首页 > 知识库问答 >
问题:

如何忽略带有特定注释的方法的checkstyle javadoc警告

李华茂
2023-03-14

当我有一个没有javadoc的公共方法时,Checkstyle会发出警告,这很好!当我重写一个公共方法时,我没有得到警告,因为javadoc已经在该方法的父类中可用。

现在,我的方法有了另一个注释,例如MyEvent。现在我确实收到了警告,但我不想要它,因为注释已经足够了。是否可以排除具有特定注释的方法的警告?

有一些解决方案涉及向我的代码中添加诸如@SuppressWarings//CHECKSTYLE. OFF之类的注释,但这并不能使我的代码更好,我可以改为添加javadoc。所以我正在寻找一个配置级别的解决方案。

共有2个答案

燕禄
2023-03-14

我可以排除带有特定注释的方法的警告吗?

您可以通过使用一个特定的注释来抑制警告(@SuppressWarnings),但不能使用其他注释来达到此效果(例如@MyEvent)。

至少不是现成的。如果你愿意做一些编程,你可以开发你自己的自定义过滤器来满足你的需要。

屠坚壁
2023-03-14

JavadocMethod模块的alalateAnnotions属性定义了javadoc检查跳过/忽略哪些已标记的方法。给定的示例使用Checkstyle v8.8。

<module name="Checker">
  <module name="TreeWalker">
    <module name="JavadocMethod">
      <property name="allowedAnnotations" value="Override, Test, Before, BeforeClass"/>
    </module>
  </module>
</module>
 类似资料:
  • 同时将warning的值设置为“all”或,没有任何结果。 checkstyle的文档很差。一些想法?

  • 例如: 我知道有jackson注解可以这样做,但是我的字段已经用我的持久性注解进行了注解,所以我想避免重复,因为我已经有了我想忽略的注解的字段

  • 问题内容: PMD可以忽略Java源文件中带有注释的特定警告。 Checkstyle有类似的选择吗? 问题答案: 是的,请查看SuppressionCommentFilter和SuppressWithNearbyCommentFilter选项。

  • 我一直在使用Metro,遇到了一个问题,wsgen似乎忽略了我在web方法响应类上添加的任何JAXB注释。 我试图返回一组实体类,我想通过网络服务向外部客户端公开,但是我只想让某些类属性和方法对外部客户端可见,所以将类存取类型设置为PROPERTY,并进行注释所有属性我想成为@XmlElement类的XML版本的一部分。 我可以使用schemagen ant任务为实体类创建XML模式,该任务正确地

  • 我正在迁移一个活动的Spring Web应用到Spring Boot(1.4.2)。 这些bean是在XML中定义的,因为它正在加载@重要资源。 我正在启动的4个bean是同一个对象BasicDataSource的实例。 为了告诉Spring要加载哪个,我为每个都设置了一个ID,并使用@Qualifer将正确的bean绑定到变量。 但Spring似乎忽略了我的@Qualifier,并抛出“没有可用

  • 我试图使用Jackson注释来重新命名序列化过程中产生的一些json标签。所有注释都编译得很好,当我运行时,除了所有Jackson注释之外,Jackson序列化工作完全被忽略。即使像@jsonignore或@jsonproperty这样的基本命令对json响应也没有影响。构建路径中的库有: 下面是我需要序列化的一个类的代码示例: