- 浏览: 82339 次
- 性别:
- 来自: 杭州
文章分类
最新评论
-
neptunecai:
2.创建nutch2.1的编译环境 这部分能详细些吗?比如:T ...
Nutch2.1 in eclipse
Checkstyle是SourceForge下的一个项目,如名所示,是检查java程序源代码编码风格的,是java程序员不可或缺的工具,用以检查自己的编码习惯是否符合公司的要求或Sun的约定。Checkstyle是目前最广泛使用的代码检查工具,功能强大,操作简单,可以和Ant结合使用,最重要的是其是Open Source的。提供了一个帮助JAVA开发人员遵守某些编码规范的工具。
CheckStyle默认提供一些主要检查内容:
·Javadoc注释
·命名约定
·标题
·Import语句
·体积大小
·空白
·修饰符
·块
·代码问题
·类设计
·混合检查(包括一些有用的,非必须的System.out和printstackTrace)
从上面可以看出,CheckStyle提供的大部分功能都是对于代码规范的检查,而没有提供象PMD和Jalopy那样的增强代码质量和修改代码的功能。但是,对于团队开发,尤其是强调代码规范的公司来说,它的功能已经足够强大。CheckStyle默认提供了对Sun编程规范的支持。通过编写配置文件,可以增加自己的检查规范。
CheckStyle的配置文件是基于XML而非Properties文件。它提供了两种运行的方式: 命令行工具和ANT任务。另外CheckStyle目前有很多针对流行IDE的插件,例如Eclipse、IntelliJ IDEA、JBuilder等。
1、和Ant配合使用
从http://sourceforge.net/project/showfiles.php?group_id=29721下载最新版本的CheckStyle,目前的版本是4.3。把解压后目录复制到项目的lib目录下,然后就可以和Ant配合使用了。
在Ant脚本中,首先定义CheckStyle的解压目录位置:
<path id="checkstyle.path">
<fileset dir="${lib.home}/checkstyle-4.3">
<include name="**/*.jar"/>
</fileset>
</path>
接着声明CheckStyle任务:
<taskdef resource="checkstyletask.properties" classpathref="checkstyle.path"/>
然后建立CheckStyle任务:
<target name="checkstyle">
<!-- 指明checkstyle的分析所需的规则文件 -->
<checkstyle config="${lib.home}/checkstyle-4.3/sun_checks.xml"
failureProperty="checkstyle.failure"
failOnViolation="false">
<!-- 指明输出格式和文件名 -->
<formatter type ="xml" tofile ="d:/report.xml"/>
<!—指明要检查的文件 -->
<fileset dir ="${src.home}">
<include name ="**/*.java"/>
</fileset>
</checkstyle>
<!-- 将xml文件转换成html文件 -->
<style in="d:/report.xml" out ="d:/report.html"
style="${lib.home}/checkstyle-4.3/contrib/checkstyle-noframes.xsl"/>
</target>
最后运行ant checkstyle即可。
注:checkstyle提供了缺省的xslt,用来进行xml的格式转换。它们都放在contrib目录中。checkstyle同样也提供了自定义的check,但与PMD相比,书写要复杂。详细情况请参见checkstyle的文档。
2、 Eclipse插件
在Eclipse当中安装CheckStyle插件非常方便,可以参照以下五个步骤进行:
a. 在Eclipse当中分别打开一下菜单 Help->Software Updates->Find and Install
b. 选择 Search for new features to install 选项然后点击 Next
c. 新建一个 New Remote Site...
d. 输入名称(比如:CheckStyle Plug-in)和下面的URL:http://eclipse-cs.sourceforge.net/update
e. 开始安装
安装好CheckStyle以后,不符合CheckStyle编码规范的信息将会出现在“问题(Problems)”视图当中,可以点击问题视图的“过滤器(Filters)”配置显示内容;
选择“Window -> Preferences -> Checkstyle”进入CheckStyle的配置页面。CheckStyle默认的sun规范检查文件是:sun_checks.xml, CheckStyle的配置文件的导入/导出就在配置页面右侧。我们也可以导出以后,经过修改量身定做自己的规范。比如我们已经按照规范做好了一个代码规范文件,并且取名为“我的软件”,那么我们可以把这个规范导入,在location中加入自定义的xml文件,Type选择External Configuration File,名称填上:“我的软件”,然后填上相应的描述,然后点击browse按钮找到相应的配置文档,点击ok就可以了。这样checkstyle当中又多了一个叫做“我的软件”的规范。
CheckStyle是一个非常复杂的代码风格检查过程:包括缩进,命名规范等,因此缺省是Disable的,启动针对一个项目的CheckStyle需要用右键点击项目,在弹出的菜单中选择“Checkstyle->Check Code with Checkstyle”。 这样,我们就能使用CheckStyle对文档进行规范了。下面这个例子是使用CheckStyle以后,在eclipse中对不符合规范的代码进行标注,这样我们就可以按照“我的软件”规范对代码进行约束了。下图当中左边的放大镜图标表示此行代码不符合规范,当鼠标悬停在上面的时候,会显示这行代码的问题所在。(图略)
3、 定制CheckStyle
在CheckStyle的最新发布版本中,有一个对于Sun的Java编码规范的配置文件信息。但是,其中有很多条目并不一定符合项目开发的需要。就算是对于很多优秀的开源项目,按照这个规范来进行检查,也会出现成千上万的错误。这就是为什么需要定制CheckStyle的原因。
CheckStyle的执行基于XML配置文件,它的主要组成部分是:
·Module:整个配置文件就是一棵Module树。根节点是Checker Module。
·Properties:它来决定一个Module如何进行检查。每个Module都有一个默认值,如果不满足开发需求,可以设定其它的值。
下面是一个示例:
<module name="MethodLength">
<property name="max" value="60"/>
</module>
它表示,如果方法或者构造函数的长度超过60行,CheckStyle就会报错。而默认值是150行。一般情况下,与IDE集成在一起使用的时候,点击出错的条目,可以跳转到相应的代码。
对于所有的模块来书,如果有这个模块则说明检测这一项,没有则不检测这一项。所有的模块中,其ROOT必须为Checker。配置文件中某些元素的具体讲解如下。
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE module PUBLIC "-//Puppy Crawl//DTD CheckeConfiguration 1.2//EN"
"http://www.puppycrawl.com/dtds/configuration_1_2.dtd">
<!-- 对于所有的模块来说,如果有这个模块则说明检测这一项,没有则不检测这一项 -->
<!-- 所有的模块中,其ROOT必须为Checker -->
<module name="Checker">
<!-- 检验每个包是否存在package.html文件-->
<!-- See http://checkstyle.sf.net/config_javadoc.html#PackageHtml -->
<!--
<module name="PackageHtml"/>
-->
<!-- 检验每个文件末尾是否有一个空行,在UNIT机器上是有的,在CVS上如果没有会有警告的-->
<!-- See http://checkstyle.sf.net/config_misc.html#NewlineAtEndOfFile -->
<!--
<module name="NewlineAtEndOfFile"/>
-->
<!-- Checks that property files contain the same keys. -->
<!-- See http://checkstyle.sf.net/config_misc.html#Translation -->
<module name="Translation" />
<module name="TreeWalker">
<!-- Checks for Javadoc comments. -->
<!-- See http://checkstyle.sf.net/config_javadoc.html -->
<!-- Checks Javadoc commentsefor method definitions.-->
<module name="JavadocMethod">
<property name="scope" value="public" />
<!-- 是否允许错误的参数声明,true为允许,缺省为不允许 -->
<property name="allowMissingParamTags" value="true" />
<!-- 是否允许错误的错误声明,true为允许,缺省为不允许 -->
<property name="allowMissingThrowsTags" value="true" />
<!-- 是否允许错误的返回类型声明,true为允许,缺省为不允许 -->
<property name="allowMissingReturnTag" value="true" />
</module>
<!--Checks Javadoc comments for class and interface definitions.-->
<module name="JavadocType" />
<!-- Checks that variables have Javadoc comments.-->
<module name="JavadocVariable">
<property name="scope" value="protected" />
</module>
<!-- 检查Javadoc的格式 -->
<module name="JavadocStyle">
<property name="scope" value="public" />
<!-- Comment的第一句的末尾是否要有一个句号,true必须有,default为true -->
<property name="checkFirstSentence" value="false" />
<!-- 检查错误的HTML脚本,比如不匹配,true检查,default为true -->
<property name="checkHtml" value="true" />
</module>
<!-- Checks for Naming Conventions. -->
<!-- See http://checkstyle.sf.net/config_naming.html -->
<!-- 确省必须以Abstract开始或者以Factory结束 -->
<!--
<module name="AbstractClassName"/>
-->
<module name="ConstantName" />
<module name="LocalFinalVariableName" />
<module name="LocalVariableName" />
<module name="MemberName" />
<module name="MethodName" />
<module name="PackageName" />
<module name="ParameterName" />
<module name="StaticVariableName" />
<module name="TypeName" />
<!-- Checks for Headers -->
<!-- See http://checkstyle.sf.net/config_header.html -->
<!-- 检查文件是否以指定文件开始,这里最好是放一些版权信息和工程描述 -->
<!-- headerFile:指定的文件 -->
<!-- ignoreLines:忽略哪些行,以","分隔 -->
<!--
<module name="Header">
<property name="headerFile" value="java.header"/>
<property name="ignoreLines" value="2, 3, 4, 5"/>
</module>
-->
<!-- Following interprets the header file as regular expressions. -->
<!--
<module name="RegexpHeader"/>
-->
<!-- Checks for imports -->
<!-- See http://checkstyle.sf.net/config_import.html -->
<!-- 检查使用*号的导入,默认为全部类 -->
<module name="AvoidStarImport" />
<!-- 检查是否有非法的包,确省检查sun.*;对于某些包是不建议直接调用的 -->
<module name="IllegalImport">
<property name="illegalPkgs" value="sun.*" />
</module>
<!-- 检查多于的导入,如一个类导入了多次 -->
<module name="RedundantImport" />
<!-- 检查没有使用的导入 -->
<module name="UnusedImports" />
<!-- 导入排序 -->
<!-- groups:分组,哪些是一组的 -->
<!-- ordered:同一个组内是否排序,true排序,确省为true -->
<!-- separated:各个组之间是否需要用空行分隔,确省为false -->
<!-- caseSensitive:是否是大小写敏感的,确省是 -->
<!--
<module name="ImportOrder">
<property name="groups" value="java,javax"/>
<property name="ordered" value="true"/>
<property name="separated"evalue="true"/>
<property name="caseSensitive" value="true"/>
</module>
-->
<!-- Checks for Size Violations. -->
<!-- See http://checkstyle.sf.net/config_sizes.html -->
<!-- 检查方法内可执行语句的个数,确省为30行 -->
<!--
<module name="ExecutableStatementCount">
<property name="max" value="30"/>
</module>
-->
<!-- 文件的最大行数,缺省为1500 -->
<module name="FileLength">
<property name="max" value="2000" />
</module>
<!-- 每行的最大字符数,缺省为80 -->
<module name="LineLength">
<!-- 忽略指定格式的行,如*号开始的,等 -->
<!--
<property name="ignorePattern" value="^ ** *[^ ]+$"/>
-->
<property name="max" value="120" />
</module>
<!-- 方法的最大行数,缺省为150 -->
<module name="MethodLength">
<property name="max" value="200" />
<!-- 统计时是否包括空行和以//开始的注释,缺省为统计(true)-->
<property name="countEmpty" value="false" />
</module>
<!-- 匿名类的最大行数,缺省为20 -->
<module name="AnonInnerLength">
<property name="max" value="60" />
</module>
<!-- 检查方法和构造子参数的最大个数,缺省为7 -->
<module name="ParameterNumber" />
<!-- Checks for whitespace -->
<!-- See http://checkstyle.sf.net/config_whitespace.html -->
<module name="EmptyForInitializerPad" />
<module name="EmptyForIteratorPad" />
<module name="MethodParamPad">
<property name="allowLineBreaks" value="true" />
</module>
<module name="NoWhitespaceAfter" />
<module name="NoWhitespaceBefore" />
<module name="OperatorWrap" />
<module name="ParenPad" />
<module name="TypecastParenPad" />
<module name="TabCharacter" />
<module name="WhitespaceAfter" />
<module name="WhitespaceAround" />
<!-- Modifier Checks -->
<!-- See http://checkstyle.sf.net/config_modifiers.html -->
<!-- 要求JLS suggestions -->
<!--
<module name="ModifierOrder"/>
-->
<module name="RedundantModifier" />
<!-- Checks for blocks. You know, those {}'s -->
<!-- See http://checkstyle.sf.net/config_blocks.html -->
<!-- 检查空块 -->
<!--
<module name="EmptyBlock"/>
-->
<module name="LeftCurly" />
<!-- 检查只有必须有{},确省为必须,主要在if,else时有这样的情况 -->
<module name="NeedBraces" />
<!-- 检查"}",确省在同一行 -->
<module name="RightCurly">
<property name="option" value="alone" />
</module>
<!-- 检查多余嵌套的{},请看文档,不易说明 -->
<module name="AvoidNestedBlocks" />
<!-- Checks for common coding problems -->
<!-- See http://checkstyle.sf.net/config_coding.html -->
<module name="AvoidInlineConditionals" />
<module name="CovariantEquals" />
<module name="DeclarationOrder" />
<module name="DefaultComesLast" />
<module name="DoubleCheckedLocking" />
<!--
<module name="EmptyStatement"/>
-->
<module name="EqualsHashCode" />
<!-- 变量必须初始化为自己的类型,如果给一个Object类型的变量初始化为null会提示 -->
<!--
<module name="ExplicitInitialization"/>
-->
<module name="FallThrough" />
<!--
<module name="FinalLocalVariable"/>
-->
<module name="HiddenField">
<property name="ignoreConstructorParameter" value="true" />
<property name="ignoreSetter" value="true" />
</module>
<!-- Exception, Throwable, RuntimeException是不允许catch的 -->
<!--
<module name="IllegalCatch"/>
-->
<module name="IllegalInstantiation" />
<!-- 有一个bug,比如i++居然都不认
<module name="IllegalToken"/>
-->
<module name="IllegalTokenText" />
<module name="IllegalType" />
<module name="InnerAssignment" />
<!--检查直接数
<module name="MagicNumber"/>
检查是否有构造子
<module name="MissingCtor"/>
-->
<module name="MissingSwitchDefault" />
<module name="MultipleVariableDeclarations" />
<!--
<module name="JUnitTestCase"/>
<module name="NestedIfDepth"">
<property name="max" value="5"/>
</module>
<module name="NestedTryDepth"">
<property name="max" value="5"/>
</module>
<module name="PackageDeclaration"/>
<module name="ReturnCount"/>
-->
<!-- 不能为参数付值 -->
<!--
<module name="ParameterAssignment"/>
-->
<module name="RedundantThrows" />
<!-- 不能理解的,好像是bug
<module name="RequireThis"/>
-->
<module name="SimplifyBooleanExpression" />
<module name="SimplifyBooleanReturn" />
<module name="StringLiteralEquality" />
<module name="SuperClone" />
<module name="SuperFinalize" />
<module name="UnnecessaryParentheses" />
<!-- Checks for class design -->
<!-- See http://checkstyle.sf.net/config_design.html -->
<!-- 要求一个方法必须声明为Extension的,否则必声明为abstract, final or empty -->
<!--
<module name="DesignForExtension"/>
-->
<!-- 检查private构造子是否声明为final,这里有个问题,在Java中构造子是不能声明为final的 -->
<!--
<module name="FinalClass"/>
-->
<!-- 要求一定要有一个构造子 -->
<!--
<module name="HideUtilityClassConstructor"/>
-->
<module name="InterfaceIsType" />
<!-- 检查变量的可见性,确省只允许static final 为public,否则只能为private -->
<module name="VisibilityModifier">
<property name="packageAllowed" value="true" />
<property name="protectedAllowed" value="true" />
</module>
<!--
<module name="MutableException"/>
-->
<!-- 限制抛出声明的指定数量,确省为1 -->
<!--
<module name="ThrowsCount"/>
-->
<!-- Miscellaneous other checks. -->
<!-- See http://checkstyle.sf.net/config_misc.html -->
<!-- 数组的声明是否允许Java的类型,确省为允许,Java类型为String[] xx,C++的类型为String xx[]; -->
<module name="ArrayTypeStyle" />
<!--
<module name="FinalParameters"/>
-->
<!-- 一般性的代码问题,不好的习惯等,可以多 -->
<!-- 文件中使用了System.out.print等-->
<module name="GenericIllegalRegexp">
<property name="format" value="System.out.print" />
<property name="message" value="bad practice of use System.out.print" />
</module>
<module name="GenericIllegalRegexp">
<property name="format" value="System.exit" />
<property name="message" value="bad practice of use System.exit" />
</module>
<module name="GenericIllegalRegexp">
<property name="format" value="printStackTrace" />
<property name="message" value="bad practice of use printStackTrace" />
</module>
<!-- 关于Task,你可以声明自己的Task标识 -->
<module name="TodoComment">
<property name="format" value="TODO" />
</module>
<!-- 强迫//注释必须如何,入下要求只能有一行,具体看文档 -->
<!--
<module name="TrailingComment">
<property name="format" value="^s*$"/>
</module>
-->
<!-- main方法经常会在debug时使用,但发行版本的时候可能并不需要这个方法,提示 -->
<!--
<module name="UncommentedMain"/>
-->
<!-- 当定义一个常量时,希望使用大写的L来代替小写的l,原因是小写的l和数字1很象 -->
<module name="UpperEll" />
<!-- 检查正确的缩进,这个更象是个人习惯 -->
<!--
<module name="Indentation">
<property name="braceAdjustment" value="0"/>
</module>
-->
<!-- Checks For Metrics -->
<!-- See http://checkstyle.sf.net/config_metrics.html -->
<!-- 检查嵌套复杂度 -->
<module name="CyclomaticComplexity">
<property name="max" value="12" />
</module>
</module>
</module>
CheckStyle默认提供一些主要检查内容:
·Javadoc注释
·命名约定
·标题
·Import语句
·体积大小
·空白
·修饰符
·块
·代码问题
·类设计
·混合检查(包括一些有用的,非必须的System.out和printstackTrace)
从上面可以看出,CheckStyle提供的大部分功能都是对于代码规范的检查,而没有提供象PMD和Jalopy那样的增强代码质量和修改代码的功能。但是,对于团队开发,尤其是强调代码规范的公司来说,它的功能已经足够强大。CheckStyle默认提供了对Sun编程规范的支持。通过编写配置文件,可以增加自己的检查规范。
CheckStyle的配置文件是基于XML而非Properties文件。它提供了两种运行的方式: 命令行工具和ANT任务。另外CheckStyle目前有很多针对流行IDE的插件,例如Eclipse、IntelliJ IDEA、JBuilder等。
1、和Ant配合使用
从http://sourceforge.net/project/showfiles.php?group_id=29721下载最新版本的CheckStyle,目前的版本是4.3。把解压后目录复制到项目的lib目录下,然后就可以和Ant配合使用了。
在Ant脚本中,首先定义CheckStyle的解压目录位置:
<path id="checkstyle.path">
<fileset dir="${lib.home}/checkstyle-4.3">
<include name="**/*.jar"/>
</fileset>
</path>
接着声明CheckStyle任务:
<taskdef resource="checkstyletask.properties" classpathref="checkstyle.path"/>
然后建立CheckStyle任务:
<target name="checkstyle">
<!-- 指明checkstyle的分析所需的规则文件 -->
<checkstyle config="${lib.home}/checkstyle-4.3/sun_checks.xml"
failureProperty="checkstyle.failure"
failOnViolation="false">
<!-- 指明输出格式和文件名 -->
<formatter type ="xml" tofile ="d:/report.xml"/>
<!—指明要检查的文件 -->
<fileset dir ="${src.home}">
<include name ="**/*.java"/>
</fileset>
</checkstyle>
<!-- 将xml文件转换成html文件 -->
<style in="d:/report.xml" out ="d:/report.html"
style="${lib.home}/checkstyle-4.3/contrib/checkstyle-noframes.xsl"/>
</target>
最后运行ant checkstyle即可。
注:checkstyle提供了缺省的xslt,用来进行xml的格式转换。它们都放在contrib目录中。checkstyle同样也提供了自定义的check,但与PMD相比,书写要复杂。详细情况请参见checkstyle的文档。
2、 Eclipse插件
在Eclipse当中安装CheckStyle插件非常方便,可以参照以下五个步骤进行:
a. 在Eclipse当中分别打开一下菜单 Help->Software Updates->Find and Install
b. 选择 Search for new features to install 选项然后点击 Next
c. 新建一个 New Remote Site...
d. 输入名称(比如:CheckStyle Plug-in)和下面的URL:http://eclipse-cs.sourceforge.net/update
e. 开始安装
安装好CheckStyle以后,不符合CheckStyle编码规范的信息将会出现在“问题(Problems)”视图当中,可以点击问题视图的“过滤器(Filters)”配置显示内容;
选择“Window -> Preferences -> Checkstyle”进入CheckStyle的配置页面。CheckStyle默认的sun规范检查文件是:sun_checks.xml, CheckStyle的配置文件的导入/导出就在配置页面右侧。我们也可以导出以后,经过修改量身定做自己的规范。比如我们已经按照规范做好了一个代码规范文件,并且取名为“我的软件”,那么我们可以把这个规范导入,在location中加入自定义的xml文件,Type选择External Configuration File,名称填上:“我的软件”,然后填上相应的描述,然后点击browse按钮找到相应的配置文档,点击ok就可以了。这样checkstyle当中又多了一个叫做“我的软件”的规范。
CheckStyle是一个非常复杂的代码风格检查过程:包括缩进,命名规范等,因此缺省是Disable的,启动针对一个项目的CheckStyle需要用右键点击项目,在弹出的菜单中选择“Checkstyle->Check Code with Checkstyle”。 这样,我们就能使用CheckStyle对文档进行规范了。下面这个例子是使用CheckStyle以后,在eclipse中对不符合规范的代码进行标注,这样我们就可以按照“我的软件”规范对代码进行约束了。下图当中左边的放大镜图标表示此行代码不符合规范,当鼠标悬停在上面的时候,会显示这行代码的问题所在。(图略)
3、 定制CheckStyle
在CheckStyle的最新发布版本中,有一个对于Sun的Java编码规范的配置文件信息。但是,其中有很多条目并不一定符合项目开发的需要。就算是对于很多优秀的开源项目,按照这个规范来进行检查,也会出现成千上万的错误。这就是为什么需要定制CheckStyle的原因。
CheckStyle的执行基于XML配置文件,它的主要组成部分是:
·Module:整个配置文件就是一棵Module树。根节点是Checker Module。
·Properties:它来决定一个Module如何进行检查。每个Module都有一个默认值,如果不满足开发需求,可以设定其它的值。
下面是一个示例:
<module name="MethodLength">
<property name="max" value="60"/>
</module>
它表示,如果方法或者构造函数的长度超过60行,CheckStyle就会报错。而默认值是150行。一般情况下,与IDE集成在一起使用的时候,点击出错的条目,可以跳转到相应的代码。
对于所有的模块来书,如果有这个模块则说明检测这一项,没有则不检测这一项。所有的模块中,其ROOT必须为Checker。配置文件中某些元素的具体讲解如下。
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE module PUBLIC "-//Puppy Crawl//DTD CheckeConfiguration 1.2//EN"
"http://www.puppycrawl.com/dtds/configuration_1_2.dtd">
<!-- 对于所有的模块来说,如果有这个模块则说明检测这一项,没有则不检测这一项 -->
<!-- 所有的模块中,其ROOT必须为Checker -->
<module name="Checker">
<!-- 检验每个包是否存在package.html文件-->
<!-- See http://checkstyle.sf.net/config_javadoc.html#PackageHtml -->
<!--
<module name="PackageHtml"/>
-->
<!-- 检验每个文件末尾是否有一个空行,在UNIT机器上是有的,在CVS上如果没有会有警告的-->
<!-- See http://checkstyle.sf.net/config_misc.html#NewlineAtEndOfFile -->
<!--
<module name="NewlineAtEndOfFile"/>
-->
<!-- Checks that property files contain the same keys. -->
<!-- See http://checkstyle.sf.net/config_misc.html#Translation -->
<module name="Translation" />
<module name="TreeWalker">
<!-- Checks for Javadoc comments. -->
<!-- See http://checkstyle.sf.net/config_javadoc.html -->
<!-- Checks Javadoc commentsefor method definitions.-->
<module name="JavadocMethod">
<property name="scope" value="public" />
<!-- 是否允许错误的参数声明,true为允许,缺省为不允许 -->
<property name="allowMissingParamTags" value="true" />
<!-- 是否允许错误的错误声明,true为允许,缺省为不允许 -->
<property name="allowMissingThrowsTags" value="true" />
<!-- 是否允许错误的返回类型声明,true为允许,缺省为不允许 -->
<property name="allowMissingReturnTag" value="true" />
</module>
<!--Checks Javadoc comments for class and interface definitions.-->
<module name="JavadocType" />
<!-- Checks that variables have Javadoc comments.-->
<module name="JavadocVariable">
<property name="scope" value="protected" />
</module>
<!-- 检查Javadoc的格式 -->
<module name="JavadocStyle">
<property name="scope" value="public" />
<!-- Comment的第一句的末尾是否要有一个句号,true必须有,default为true -->
<property name="checkFirstSentence" value="false" />
<!-- 检查错误的HTML脚本,比如不匹配,true检查,default为true -->
<property name="checkHtml" value="true" />
</module>
<!-- Checks for Naming Conventions. -->
<!-- See http://checkstyle.sf.net/config_naming.html -->
<!-- 确省必须以Abstract开始或者以Factory结束 -->
<!--
<module name="AbstractClassName"/>
-->
<module name="ConstantName" />
<module name="LocalFinalVariableName" />
<module name="LocalVariableName" />
<module name="MemberName" />
<module name="MethodName" />
<module name="PackageName" />
<module name="ParameterName" />
<module name="StaticVariableName" />
<module name="TypeName" />
<!-- Checks for Headers -->
<!-- See http://checkstyle.sf.net/config_header.html -->
<!-- 检查文件是否以指定文件开始,这里最好是放一些版权信息和工程描述 -->
<!-- headerFile:指定的文件 -->
<!-- ignoreLines:忽略哪些行,以","分隔 -->
<!--
<module name="Header">
<property name="headerFile" value="java.header"/>
<property name="ignoreLines" value="2, 3, 4, 5"/>
</module>
-->
<!-- Following interprets the header file as regular expressions. -->
<!--
<module name="RegexpHeader"/>
-->
<!-- Checks for imports -->
<!-- See http://checkstyle.sf.net/config_import.html -->
<!-- 检查使用*号的导入,默认为全部类 -->
<module name="AvoidStarImport" />
<!-- 检查是否有非法的包,确省检查sun.*;对于某些包是不建议直接调用的 -->
<module name="IllegalImport">
<property name="illegalPkgs" value="sun.*" />
</module>
<!-- 检查多于的导入,如一个类导入了多次 -->
<module name="RedundantImport" />
<!-- 检查没有使用的导入 -->
<module name="UnusedImports" />
<!-- 导入排序 -->
<!-- groups:分组,哪些是一组的 -->
<!-- ordered:同一个组内是否排序,true排序,确省为true -->
<!-- separated:各个组之间是否需要用空行分隔,确省为false -->
<!-- caseSensitive:是否是大小写敏感的,确省是 -->
<!--
<module name="ImportOrder">
<property name="groups" value="java,javax"/>
<property name="ordered" value="true"/>
<property name="separated"evalue="true"/>
<property name="caseSensitive" value="true"/>
</module>
-->
<!-- Checks for Size Violations. -->
<!-- See http://checkstyle.sf.net/config_sizes.html -->
<!-- 检查方法内可执行语句的个数,确省为30行 -->
<!--
<module name="ExecutableStatementCount">
<property name="max" value="30"/>
</module>
-->
<!-- 文件的最大行数,缺省为1500 -->
<module name="FileLength">
<property name="max" value="2000" />
</module>
<!-- 每行的最大字符数,缺省为80 -->
<module name="LineLength">
<!-- 忽略指定格式的行,如*号开始的,等 -->
<!--
<property name="ignorePattern" value="^ ** *[^ ]+$"/>
-->
<property name="max" value="120" />
</module>
<!-- 方法的最大行数,缺省为150 -->
<module name="MethodLength">
<property name="max" value="200" />
<!-- 统计时是否包括空行和以//开始的注释,缺省为统计(true)-->
<property name="countEmpty" value="false" />
</module>
<!-- 匿名类的最大行数,缺省为20 -->
<module name="AnonInnerLength">
<property name="max" value="60" />
</module>
<!-- 检查方法和构造子参数的最大个数,缺省为7 -->
<module name="ParameterNumber" />
<!-- Checks for whitespace -->
<!-- See http://checkstyle.sf.net/config_whitespace.html -->
<module name="EmptyForInitializerPad" />
<module name="EmptyForIteratorPad" />
<module name="MethodParamPad">
<property name="allowLineBreaks" value="true" />
</module>
<module name="NoWhitespaceAfter" />
<module name="NoWhitespaceBefore" />
<module name="OperatorWrap" />
<module name="ParenPad" />
<module name="TypecastParenPad" />
<module name="TabCharacter" />
<module name="WhitespaceAfter" />
<module name="WhitespaceAround" />
<!-- Modifier Checks -->
<!-- See http://checkstyle.sf.net/config_modifiers.html -->
<!-- 要求JLS suggestions -->
<!--
<module name="ModifierOrder"/>
-->
<module name="RedundantModifier" />
<!-- Checks for blocks. You know, those {}'s -->
<!-- See http://checkstyle.sf.net/config_blocks.html -->
<!-- 检查空块 -->
<!--
<module name="EmptyBlock"/>
-->
<module name="LeftCurly" />
<!-- 检查只有必须有{},确省为必须,主要在if,else时有这样的情况 -->
<module name="NeedBraces" />
<!-- 检查"}",确省在同一行 -->
<module name="RightCurly">
<property name="option" value="alone" />
</module>
<!-- 检查多余嵌套的{},请看文档,不易说明 -->
<module name="AvoidNestedBlocks" />
<!-- Checks for common coding problems -->
<!-- See http://checkstyle.sf.net/config_coding.html -->
<module name="AvoidInlineConditionals" />
<module name="CovariantEquals" />
<module name="DeclarationOrder" />
<module name="DefaultComesLast" />
<module name="DoubleCheckedLocking" />
<!--
<module name="EmptyStatement"/>
-->
<module name="EqualsHashCode" />
<!-- 变量必须初始化为自己的类型,如果给一个Object类型的变量初始化为null会提示 -->
<!--
<module name="ExplicitInitialization"/>
-->
<module name="FallThrough" />
<!--
<module name="FinalLocalVariable"/>
-->
<module name="HiddenField">
<property name="ignoreConstructorParameter" value="true" />
<property name="ignoreSetter" value="true" />
</module>
<!-- Exception, Throwable, RuntimeException是不允许catch的 -->
<!--
<module name="IllegalCatch"/>
-->
<module name="IllegalInstantiation" />
<!-- 有一个bug,比如i++居然都不认
<module name="IllegalToken"/>
-->
<module name="IllegalTokenText" />
<module name="IllegalType" />
<module name="InnerAssignment" />
<!--检查直接数
<module name="MagicNumber"/>
检查是否有构造子
<module name="MissingCtor"/>
-->
<module name="MissingSwitchDefault" />
<module name="MultipleVariableDeclarations" />
<!--
<module name="JUnitTestCase"/>
<module name="NestedIfDepth"">
<property name="max" value="5"/>
</module>
<module name="NestedTryDepth"">
<property name="max" value="5"/>
</module>
<module name="PackageDeclaration"/>
<module name="ReturnCount"/>
-->
<!-- 不能为参数付值 -->
<!--
<module name="ParameterAssignment"/>
-->
<module name="RedundantThrows" />
<!-- 不能理解的,好像是bug
<module name="RequireThis"/>
-->
<module name="SimplifyBooleanExpression" />
<module name="SimplifyBooleanReturn" />
<module name="StringLiteralEquality" />
<module name="SuperClone" />
<module name="SuperFinalize" />
<module name="UnnecessaryParentheses" />
<!-- Checks for class design -->
<!-- See http://checkstyle.sf.net/config_design.html -->
<!-- 要求一个方法必须声明为Extension的,否则必声明为abstract, final or empty -->
<!--
<module name="DesignForExtension"/>
-->
<!-- 检查private构造子是否声明为final,这里有个问题,在Java中构造子是不能声明为final的 -->
<!--
<module name="FinalClass"/>
-->
<!-- 要求一定要有一个构造子 -->
<!--
<module name="HideUtilityClassConstructor"/>
-->
<module name="InterfaceIsType" />
<!-- 检查变量的可见性,确省只允许static final 为public,否则只能为private -->
<module name="VisibilityModifier">
<property name="packageAllowed" value="true" />
<property name="protectedAllowed" value="true" />
</module>
<!--
<module name="MutableException"/>
-->
<!-- 限制抛出声明的指定数量,确省为1 -->
<!--
<module name="ThrowsCount"/>
-->
<!-- Miscellaneous other checks. -->
<!-- See http://checkstyle.sf.net/config_misc.html -->
<!-- 数组的声明是否允许Java的类型,确省为允许,Java类型为String[] xx,C++的类型为String xx[]; -->
<module name="ArrayTypeStyle" />
<!--
<module name="FinalParameters"/>
-->
<!-- 一般性的代码问题,不好的习惯等,可以多 -->
<!-- 文件中使用了System.out.print等-->
<module name="GenericIllegalRegexp">
<property name="format" value="System.out.print" />
<property name="message" value="bad practice of use System.out.print" />
</module>
<module name="GenericIllegalRegexp">
<property name="format" value="System.exit" />
<property name="message" value="bad practice of use System.exit" />
</module>
<module name="GenericIllegalRegexp">
<property name="format" value="printStackTrace" />
<property name="message" value="bad practice of use printStackTrace" />
</module>
<!-- 关于Task,你可以声明自己的Task标识 -->
<module name="TodoComment">
<property name="format" value="TODO" />
</module>
<!-- 强迫//注释必须如何,入下要求只能有一行,具体看文档 -->
<!--
<module name="TrailingComment">
<property name="format" value="^s*$"/>
</module>
-->
<!-- main方法经常会在debug时使用,但发行版本的时候可能并不需要这个方法,提示 -->
<!--
<module name="UncommentedMain"/>
-->
<!-- 当定义一个常量时,希望使用大写的L来代替小写的l,原因是小写的l和数字1很象 -->
<module name="UpperEll" />
<!-- 检查正确的缩进,这个更象是个人习惯 -->
<!--
<module name="Indentation">
<property name="braceAdjustment" value="0"/>
</module>
-->
<!-- Checks For Metrics -->
<!-- See http://checkstyle.sf.net/config_metrics.html -->
<!-- 检查嵌套复杂度 -->
<module name="CyclomaticComplexity">
<property name="max" value="12" />
</module>
</module>
</module>
发表评论
-
jetty 对请求头的限制
2014-02-13 14:30 5702当浏览器发起请求时 出现http code 413 问题 fu ... -
java 最基础的设置介绍
2013-04-15 23:05 1282用java不长不短快5年了,最近在看一些基础的书籍,也想起很久 ... -
Hessian 初体验
2013-03-27 17:36 1197Hessian 官网:http://hessian.cauch ... -
Nutch2.1 in eclipse
2013-03-10 00:22 9464Nutch2.1 in eclipse 主要目的: 1. 将 ... -
LDAP connection issue
2012-10-23 16:25 1753Problem1: Sometimes we can not ... -
restlet2.0学习——请求超时设置
2012-09-26 11:01 2363一般,我们在请求一个rest service的时候,总是希望可 ... -
[转载]高性能JAVA开发之内存管理
2012-08-13 21:53 1385这几天在找一个程序的bug,主要是java虚拟机内存溢出的问题 ... -
[转载]How to write LDAP search filters
2012-08-10 10:57 1438This document outlines how to g ... -
restlet2.0学习(extend)-restlet日志信息写入log4j中
2012-08-07 15:32 4055使用过restlet的人都知道,restlet使用的是JDK的 ... -
log4j级别输出
2012-08-03 11:12 4333我们知道: log4j.logger.XX cover ==& ... -
log4j配置
2012-05-30 11:36 1441log4j.rootLogger 根路径下的所有logger输 ... -
Restlet2.0学习——简单WebApp多Application与表单提交
2012-05-23 23:16 3582之前我们提到过简单的WebApp实现,使用的是一个applic ... -
Restlet2.0学习——文件路径访问
2012-05-22 14:42 1230由于就是官方的实例照搬了一下,简单尝试没有问题。就先把代码贴出 ... -
Restlet2.0学习——文件路径访问+BASIC认证
2012-05-22 14:38 1780这篇主要是让我们学习对于一些静态页面如何更加简单有效的去访问他 ... -
对RAM做简单的池化实现
2012-05-22 13:59 1566首先由于项目的关系需要使用IBM的Rational Asser ... -
Restlet2.0学习——简单WebApp实现
2012-05-21 22:09 6561由于自己最近正在学习R ... -
HTMLPOST和GET编码问题(深入篇)
2011-07-07 02:12 11447浏览器 IE/FireFox -------——----> ...
相关推荐
这个"Checkstyle 使用手册 以及常用方法"涵盖了Checkstyle的基本使用和一些常见功能的详细解释。 首先,了解如何配置和运行Checkstyle至关重要。Checkstyle可以通过命令行、IDE插件(如Eclipse、IntelliJ IDEA)...
### CheckStyle 使用手册知识点详述 #### 一、CheckStyle 概述 - **定义**:CheckStyle 是 SourceForge 下的一个开源项目,旨在为 Java 开发者提供一套自动化工具,帮助他们遵循一定的编码规范和标准。 - **核心...
《CheckStyle使用手册》 CheckStyle是一款用于检查Java源代码风格的工具,它可以帮助开发者遵循特定的编码规范和约定,确保代码的一致性和可读性。这篇使用手册将深入介绍CheckStyle的功能、配置以及如何在实际开发...
Excel格式的Checkstyle5.5中文手册。
在Ant构建脚本中,可以使用类似以下的代码片段来运行Checkstyle任务: ```xml <taskdef resource="checkstyletask.properties" classpathref="checkstyle-all-3.4.jar"/> <target name="checkstyle_check" depends=...
通过使用CheckStyle,开发团队可以减少代码审查的工作量,提高代码质量,并降低维护成本。这款工具能够检查出代码中的常见错误,如不一致的命名约定、未使用的变量、不必要的导入等。 CheckStyle的中文文档对于中国...
"CheckStyle使用详解" CheckStyle是一款功能强大且操作简单的代码检查工具,它可以与Ant结合使用,并且是Open Source的,这意味着用户不需要担心收到律师函。CheckStyle的主要功能是检查Java代码的格式和风格,以...
这个"Checkstyle_4.3_中文手册 pdf"是Checkstyle 4.3版本的中文指南,对于理解并使用Checkstyle进行代码质量管理非常有帮助。 在Checkstyle 4.3版本中,主要包含以下知识点: 1. **Checkstyle基础**:Checkstyle...
### CheckStyle 使用说明详解 #### 一、引言 随着软件项目的规模不断扩大,代码的质量问题逐渐成为制约项目进度的关键因素之一。为了确保代码的一致性和可维护性,很多团队都会制定一套编码规范,并定期进行代码...
Checkstyle是一款广泛使用的Java编程语言的静态代码分析工具,它帮助开发者遵循特定的编码规范和最佳实践,确保代码的一致性和可读性。本指南将详细介绍Checkstyle的安装过程、配置方法以及如何在项目中使用它。 ...
以下是关于如何在 Maven 项目中配置和使用 Checkstyle 插件的详细步骤及知识点解析: 1. **配置 Checkstyle 插件**: 在 Maven 项目的 `pom.xml` 文件的 `<reporting>` 部分,我们需要添加 Checkstyle 插件的相关...
在Eclipse集成开发环境中使用CheckStyle,可以实时地提醒开发者遵守编码规范,从而提升开发体验。 首先,你需要下载`checkStyle`压缩包,其中包含了CheckStyle的安装文件。解压后,你会发现里面包含了一些必要的...
Checkstyle是一款广泛使用的Java编程语言的静态代码分析工具,它主要的作用是检查代码是否符合预设的编码规范和风格。这个“Checkstyle压缩包和使用说明”包含了Checkstyle的安装包以及详细的使用指南,帮助开发者...
【Checkstyle使用说明】 Checkstyle是一款强大的Java代码检查工具,它可以帮助开发者遵循特定的编码规范和最佳实践。这款工具广泛应用于各种项目,以确保代码的一致性和可维护性。通过执行一系列预定义的规则,...
Checkstyle 是一个开源的...2. **引入 Checkstyle Task**: 使用 `taskdef` 元素引入 Checkstyle 的任务定义,需要指定资源文件(通常是 `checkstyletask.properties`)以及 Checkstyle JAR 文件的类路径引用。 ```xml ...