由于我对checkstyle也不是很熟悉,在这里就根据checkstyle检查我所做的团队项目的结果来罗列一下常见的错误。以下按错误的从多到少排列。
checkstyle violation type | 解释 | 解决 | 备注 |
---|---|---|---|
Missing a Javadoc comment | 缺少JavaDoc注释 | 增加javadoc注释 | javadoc-百度百科 |
'X' is not followed by whitespace | “X”后面缺少空格 | 添加空格 | |
Line has trailing spaces. | 多余的空行 | 去掉空行 | |
Parameter 'X' should be final | “X”应该为final类型 | 在前面加个final | |
name 'X' must match pattern 'X' | 变量“X”不符合命名规则“X” | 把这个命名改成符合规则的命名 | |
'X' is not preceded with whitespace | “X”前面没有空格 | 添加空格 | |
'X' hides a field. | 全局和局部变量名字重复 | 重命名 | |
Line is longer than X characters | 行长度超过X | 分成多行写 | 文字分散对齐Ctrl+shift+f |
Expected X tag for'X' | 在注释中希望有X的说明 | 在方法前得注释中添加注释 | |
Redundant 'X' modifier | 冗余的“X” | 删除X | |
File contains a tab characters | 文件中含有”tab” 字符 | 把tab换成四个空格 | 可以使用Editplus中的format功能 |
'X' is a magic number | X是一个魔术数字(非0、1、2的数字) | 对于直接用代码中的数字,进行常量的定义 | 一般没什么关系 |
Unused import -X | 导进来的X没有被使用 | 去掉导入的多余的类 | |
Expected an @return tag | 希望有一个return的注释 | 添加该注释 | |
First sentence should end with a period | 你的注释的第一行文字结束应该加上一个"." | 加上“.” | |
'X' Is preceeded with whitespace | “X”前面不能有空格 | 去掉空格 | |
Variable X' must be private and have accessor methods | 变量要改成private然后提供访问的方法 | 给这些变量的修饰符改成private,然后提供set,get方法,并加上对应的方法javadoc注释、参数注释。 | |
File does not end with a newline | 删掉报错的类,新建一个同名的类,把代码全部复制过去 |