CheckStyle及其配置的详细解释
代码格式化的好处我想我就不需要说了,大家肯定也都理解其优点,否则你也不会看这个文档.
这里我以CheckStyle3.4为例,讲解CheckStyle的使用,确切的说是其配置的具体解释,假如你是Checkstyle3.4以下,那么有一部分module将是不可以答应的,请删除之;在这份文档中我试图把所有的module都分析讲解一次,同时下面的这份文档也是我的设置,对于我个人不喜欢的设置我都注释了,假如你需要请取消注释或如何!!
Checkstyle简介,其是目前最广泛使用的代码检查工具,功能强大,操作简单可以和Ant结合使用,最重要的是其是Open Source的,你不用担心收到律师函,哈哈!
主页: http://checkstyle.sourceforge.net/
下载本文示例: olics_checkstyle_checks.zip
开始我们的讲解:
首先,Checkstyle可以和Ant结合使用,下面是Ant脚步片断
<!--CheckStyle配置,这里你替换成你实际的环境-->
<property name="checkstyle.config" value="${project.docs.dir}/checkstyle_checks.XML"/>
<property name="checkstyle.report.style" value="${project.docs.dir}/checkstyle-frames.xsl"/>
<property name="checkstyle.result" value="${build.checkstyleReport.dir}/checkstyle_result.xml"/>
<property name="checkstyle.report" value="${build.checkstyleReport.dir}/checkstyle_report.Html"/>
<!―CheckStyle脚步-->
<taskdef resource="checkstyletask.properties" classpathref=" checkstyle-all-3.4.jar"/>
<target name="checkstyle_check" depends="init">
<checkstyle config="${checkstyle.config}" failOnViolation="false" failureProperty="checkstyle.failure">
<formatter type="xml" tofile="${checkstyle.result}"/>
<fileset dir="${project.src.dir}" includes="**/*.Java"/>
</checkstyle>
<!―生成报告,其格式取决于${checkstyle.report.style}-->
<style in="${checkstyle.result}" out="${checkstyle.report}" style="${checkstyle.report.style}"/>
</target>
下面是我理解的 Checkstyle 的使用 :
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE module PUBLIC "-//Puppy Crawl//DTD Check Configuration 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 comments for 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" value="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="ParameterN
关注此文的读者还看过：
·2013-8-13 8:55:48 使用Java将Word转为Html或txt!
·2013-8-13 8:55:48 精通Hibernate之映射继承关系七(图)
·2013-8-13 8:55:47 根据name调用getName方法
·2013-8-13 8:55:46 Java GUI误解 因为外观而拒绝Swing？
·2013-8-13 8:55:38 Java的字符串操作
·2013-8-13 8:55:36 Java的文件与磁盘操作
资料引用:http://www.knowsky.com/367856.html
CheckStyle及其配置的详细解释相关推荐
- LoRa亿佰特 E22-400T22S 临时寄存器和无线配置的详细解释
说明书写的太烂...不过技术支持 刘CHAO工程师 太赞了,很有耐心的指导,在此感谢! 1.临时寄存器 就是掉电后不保存,所有参数变成默认值. 1 2.无线配置 大概流程如下 LoRa亿佰特 E22- ...
- linux查看xml文件的配置,Hibernate配置文件hibernate.cfg.xml的详细解释
Hibernate配置文件hibernate.cfg.xml的详细解释 [日期:2012-12-13] 来源:Linux社区 作者:jqyp [字体:大 中 小] /p> "-//Hi ...
- MapReduce的工作原理，详细解释WordCount程序
本篇文章主要说两部分:简单介绍MapReduce的工作原理:详细解释WordCount程序. MapReduce的工作原理 在<Hadoop in action>一书中,对MapReduc ...
- post修改服务器数据源,postgresql安装及配置超详细教程
1. 安装 根据业务需求选择版本,官网下载 初始化数据库 执行完初始化任务之后,postgresql 会自动创建和生成两个用户和一个数据库: linux 系统用户 postgres:管理数据库的系统用 ...
- Spring中IOC和AOP的详细解释（转）
原文链接:Spring中IOC和AOP的详细解释 我们是在使用Spring框架的过程中,其实就是为了使用IOC,依赖注入,和AOP,面向切面编程,这两个是Spring的灵魂. 主要用到的设计模式有工厂 ...
- tar.gz 和 tar.bz2 详细解释
原文请见 tar.gz 和tar.bz2 详细解释. 大多以 tar.gz 和 tar.bz2 打包软件,大多是通过 ./configure make make install 来安装的:有的软件是直 ...
- php.ini配置文件中文详细解释
php.ini配置文件中文详细解释 ;;;;;;;;;;; ; 警告 ; ;;;;;;;;;;; ; 此配置文件是对于新安装的PHP的默认设置. ; ; 此配置针对开发目的,并且*不是*针对生产环境 ...
- 新手教程：建立网站的全套流程与详细解释
新手教程:建立网站的全套流程与详细解释 你要是 Baidu 这个话题,得到的结果八成都是广告--他们都会告诉你,"嘿,我(或某公司)这里可以建网站,傻瓜式的哟,快来投奔我吧!" 新 ...
- resin配置文件的详细解释
下面是resin配置文件的详细解释: http://blog.chinaunix.net/uid-25892360-id-3059362.html <!-- - Resin 3.1 配置文件. ...
最新文章
- 样本量极少如何机器学习？最新Few-Shot Learning综述
- python使用界面-推荐8款常用的Python GUI图形界面开发框架
- 实用计算机技术选修,实用计算机组装与维护选修课学习心得
- 卓讯企业名录搜索软件_还在用卓讯企业名录搜索软件吗？探迹黑科技助力企业提升销售效率...
- 从零开始入门 | Kubernetes 中的服务发现与负载均衡
- 未公开接口主要指以下哪几类_Java8的 Stream 函数式接口，你了解多少？
- 在php获取访问方的ip
- C#开发纽曼来电小秘书总结（指南）
- jzoj2137-(GDKOI2004)城市统计【二维前缀和,bfs】
- 信息学奥赛一本通 1048：有一门课不及格的学生 | OpenJudge NOI 1.4 10
- 【LeetCode】剑指 Offer 53 - I. 在排序数组中查找数字 I
- 总结分析一下三种求解最短路问题的算法,dijkstra算法，spfa算法，floyd算法。
- 操作系统安全 基本概念
- 分布式技术(2)大型网站架构利器－CDN技术
- 如何制作印章水印？教你在线制作电子印章水印
- HttpClient的使用与连接资源释放
- Fast-paced Multiplayer
- 计算机怎么转换英语版本,电脑英文字母大小写怎么转换
- Maple: 矩阵转置
- 比我的脸还干的gan货——Python Flask Web 框架入门