java代码规范之MethodName

2022-03-29 13:50:05 浏览数 (2)

俗话说无规矩不成方圆,写代码也是这样,如果没有一定的规范去约束,那么写出来的代码风格肯定千差万别,开源项目一般都会有自己的代码规范,不管是skywalking项目,还是nacos项目都有,好了废话不多说了,进入本文的正题:MethodName,这是maven checkstyle插件对方法名称的校验。

代码语言:javascript复制
    <module name="TreeWalker">
        <!-- 方法名的校验 -->
        <module name="MethodName"/>

MethodName对应com.puppycrawl.tools.checkstyle.checks.naming.MethodNameCheck这个类,该类有以下几个属性:

  • format 方法名命名规则,该属性填写正则表达式,默认为^[a-z][a-zA-Z0-9]*$,即小驼峰命名,且只能包含字母、数字,必须以字母开始
  • allowClassName 是否允许有方法名称能跟类名相同(除构造方法外),默认是不允许的
  • applyToPublic 是否校验public类型的方法,默认校验(true)
  • applyToProtected 是否校验protected类型方法,默认校验(true)
  • applyToPackage 是否校验包访问类型的方法,默认校验(true)
  • applyToPrivate 是否校验private类型的方法,默认校验(true)

0 人点赞