Eclipse - CheckStyle

编码标准插件

每个公司几乎都有应该设置一份编码规范:类命名、包命名、代码风格之类的东西都属于其中。而CheckStyle插件可以检查这些规范。

CheckStyle

插件URL:http://eclipse-cs.sourceforge.net/update/

  • 在Marketplaces上install不知道为啥失败了,说找不到解决方案(solution)。Install New Software也失败了… 最后用了最后一种方案,在其官网上下载压缩包,放在dropins中。
  • 虽然这个插件也有MAVEN版本的,但它的结果是保存在一个xml文件中的,还要打开去看,不方便。

常见的CheckStyle错误有这些:

  1. Type is missing a javadoc commentClass
    缺少类型说明
  2. “{” should be on the previous line
    “{” 应该位于前一行
  3. Methods is missing a javadoc comment
    方法前面缺少javadoc注释
  4. Expected @throws tag for “Exception”
    在注释中希望有@throws的说明
    5.“.” Is preceeded with whitespace “.”
    前面不能有空格
    6.“.” Is followed by whitespace“.”
    后面不能有空格
    7.“=” is not preceeded with whitespace
    “=” 前面缺少空格
    8.“=” is not followed with whitespace
    “=” 后面缺少空格
    9.“}” should be on the same line
    “}” 应该与下条语句位于同一行
    10.Unused @param tag for “unused”
    没有参数“unused”,不需注释
    11.Variable “CA” missing javadoc
    变量“CA”缺少javadoc注释
    12.Line longer than 80characters
    行长度超过80
    13.Line contains a tab character
    行含有”tab” 字符
    14.Redundant “Public” modifier
    冗余的“public” modifier
    15.Final modifier out of order with the JSL
    suggestionFinal modifier的顺序错误
    16.Avoid using the “.*” form of import
    Import格式避免使用“.*”
    17.Redundant import from the same package
    从同一个包中Import内容
    18.Unused import-java.util.list
    Import进来的java.util.list没有被使用
    19.Duplicate import to line 13
    重复Import同一个内容
    20.Import from illegal package
    从非法包中 Import内容
    21.“while” construct must use “{}”
    “while” 语句缺少“{}”
    22.Variable “sTest1” must be private and have accessor method
    变量“sTest1”应该是private的,并且有调用它的方法
    23.Variable “ABC” must match pattern “^[a-z][a-zA-Z0-9]* ABC[az][azAZ09]
    24.“(” is followed by whitespace
    “(” 后面不能有空格
    25.“)” is proceeded by whitespace
    “)” 前面不能有空格

Tips:

你可能感兴趣的:(eclipse,编码,解决方案)