CheckStyle:注释样式必须是 ‘COMPACT’

CheckStyle:注释样式必须是 ‘COMPACT’

场景

提交 Spring PR 集成 CheckStyle 插件,代码提示 CheckStyle:注释样式必须是 ‘COMPACT’

解决

将注解 @ConditionalOnProperty(value = "xxx 修改为 @ConditionalOnProperty("xxx"),换句话说,当只指定注解 value 属性时,就可以省略 value 名称了,这种注解格式就是 COMPACT

其他

Checkstyle 的几种注解格式:

  • EXPANDED:最完整的格式,即 name=parameter
  • COMPACT:压缩格式,当注解只有 value 属性或者其他属性都有默认值时使用,比如 @ConditionalOnProperty("xxx")
  • COMPACT_NO_ARRAY:跟 COMPACT 类似,只是当注解元素是数组类型且只有一个值时,可以不加 {}

相关

https://checkstyle.org/config_annotation.html#AnnotationUseStyle


版权声明:本文为weixin_42189048原创文章,遵循CC 4.0 BY-SA版权协议,转载请附上原文出处链接和本声明。