checkStyle ant使用方式配置说明Word文件下载.docx
- 文档编号:19187614
- 上传时间:2023-01-04
- 格式:DOCX
- 页数:17
- 大小:793.51KB
checkStyle ant使用方式配置说明Word文件下载.docx
《checkStyle ant使用方式配置说明Word文件下载.docx》由会员分享,可在线阅读,更多相关《checkStyle ant使用方式配置说明Word文件下载.docx(17页珍藏版)》请在冰豆网上搜索。
/module>
结束。
根据api可以知道具体的module中可以提供哪些property属性。
因此可以添加或删除module模块来配置checkStyle需要检查哪些规则。
把创建好的build.xml、sunrising_checks.xml、user.properties这三个文件拷贝到刚才下载解压好的checkStyle根目录下
4.执行ant:
以下为本机checkStyle-5.3所在目录下运行结果:
提示ant运行成功
查看E盘下将生成
通过xml文件可以查看到:
<
filename="
E:
\workSpace\emp\src\com\ruijie\emp\a\FileViewer.java"
>
<
errorline="
0"
severity="
error"
message="
Missingpackage-info.javafile."
source="
com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocPackageCheck"
/>
15"
column="
1"
Filecontainstabcharacters
(thisisthefirstinstance)."
source="
com.puppycrawl.tools.checkstyle.checks.
whitespace.FileTabCharacterCheck"
22"
95"
Gotanexception-Unexpected
character0xfe40inidentifier"
com.puppycrawl.tools.checkstyle.TreeWalker"
49"
Linehastrailingspaces."
com.puppycrawl.tools.checkstyle.checks.regexp.RegexpSinglelineCheck"
98"
/file>
详细描述:
:
错误所在的类
:
出错行数。
错误级别
错误详细描述。
给出此错误的源码类文件。
还可以通过生成的html文件查看:
点击相应的类文件可以查看详细错误信息:
由于错误类型比较多不能列举所有具体可查看:
以下对sunrising_checks.xml文件中涉及到的常用的配置规则进行解释:
、
!
DOCTYPEmodulePUBLIC"
-//PuppyCrawl//DTDCheckConfiguration1.2//EN"
"
modulename="
Checker"
--重复代码的检查,超过8行就认为重复,UTF-8格式本检查一定要放在"
TreeWalker"
节点前,否则在Checkclipse中会无法使用。
(在ant下可以)-->
StrictDuplicateCode"
<
propertyname="
min"
value="
8"
<
charset"
UTF-8"
--javadoc的检查-->
--检查所有的interface和class-->
JavadocType"
--检查所有方法的javadoc,可以不声明RuntimeException-->
JavadocMethod"
allowUndeclaredRTE"
true"
--检查某个变量的javadoc-->
JavadocVariable"
--命名方面的检查,它们都使用了Sun官方定的规则。
-->
--类名(class或interface)的检查-->
TypeName"
--变量的检查-->
MemberName"
--方法名的检查-->
MethodName"
--方法的参数名-->
ParameterName"
--常量名的检查-->
ConstantName"
--长度方面的检查-->
--文件长度不超过1500行-->
FileLength"
max"
1500"
--每行不超过120个字-->
LineLength"
120"
--方法不超过30行-->
MethodLength"
tokens"
METHOD_DEF"
30"
--方法的参数个数不超过3个。
ParameterNumber"
3"
--多余的关键字-->
RedundantModifier"
--对区域的检查-->
--不能出现空白区域-->
EmptyBlock"
--所有区域都要使用大括号。
NeedBraces"
--多余的括号-->
AvoidNestedBlocks"
propertyname="
allowInSwitchCase"
--编码方面的检查-->
--不许出现空语句-->
EmptyStatement"
--每个类都实现了equals()和hashCode()-->
EqualsHashCode"
--不许使用switch-->
IllegalToken"
LITERAL_SWITCH"
--不许内部赋值-->
InnerAssignment"
--绝对不能容忍魔法数-->
MagicNumber"
--循环控制变量不能被修改-->
ModifiedControlVariable"
--多余的throw-->
RedundantThrows"
--不许使用未被简化的条件表达式-->
SimplifyBooleanExpression"
--不许使用未被简化的布尔返回值-->
SimplifyBooleanReturn"
--String的比较不能用!
=和==-->
StringLiteralEquality"
--if最多嵌套3层-->
NestedIfDepth"
--try最多被嵌套1层-->
NestedTryDepth"
--clone方法必须调用了super.clone()-->
SuperClone"
--finalize必须调用了super.finalize()-->
SuperFinalize"
--不能catchjava.lang.Exception-->
IllegalCatch"
illegalClassNames"
java.lang.Exception"
--JUnitTestCase的核心方法存在。
JUnitTestCase"
--一个方法中最多有3个return-->
ReturnCount"
--不许对方法的参数赋值-->
ParameterAssignment"
--不许有同样内容的String-->
MultipleStringLiterals"
--同一行不能有多个声明-->
MultipleVariableDeclarations"
--各种量度-->
--布尔表达式的复杂度,不超过3-->
BooleanExpressionComplexity"
--类数据的抽象耦合,不超过7-->
ClassDataAbstractionCoupling"
--类的分散复杂度,不超过20-->
ClassFanOutComplexity"
--函数的分支复杂度,不超过10-->
CyclomaticComplexity"
--NPath复杂度,不超过200-->
NPathComplexity"
--杂项-->
--禁止使用System.out.println-->
GenericIllegalRegexp"
format"
System\.out\.println"
ignoreComments"
--不许使用与代码同行的注释-->
TrailingComment"
--检查翻译文件-->
Translation"
二、CheckStyle在eclipse中的配置:
1.需下载checkStyleeclipse插件
下载地址:
安装完插件在eclipse–>
preferences下将出现checkStyle选项:
配置项说明:
在此页面中可以选中左边列表中的信息通过“add…->
”添加到右边列表中。
检查
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- checkStyle ant使用方式配置说明 ant 使用 方式 配置 说明