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

时间: 2024-12-31 15:50:03

CheckStyle及其配置的详细解释的相关文章

求助 int num=030;求详细解释

问题描述 求助 int num=030:求详细解释 int num =030:System.out.println(num);为什么打印出来会是24呢??求大神详细解释 解决方案 楼主可以试试两个极端:你这里写的是int num = 030;由于在30前写了0就被编译器当成了8进制数据,8进制数据30就是10进制的24.你可以试试将语句改成:int num = 080;看看你的系统编译会不会报错 解决方案二: 030表示的是八进制数~ 解决方案三: 030是8进制的表示方式,转换成int十进制n

win7库功能的详细解释

库相信用过电脑一段时间的人都不陌生,但是如果刚刚用win7或者一直用xp系统的人,对于库肯定是完全不了解.因为在xp系统里面库的用处非常少,最少小编用了几年的xp重来没想过用库来方便自己存放文件. 1 关于win7库,微软给出的解答: 库是用于管理文档.音乐.图片和其他文件的位置.可以使用与在文件夹中浏览文件相同的方式浏览文件,也可以查看按属性(如日期.类型和作者)排列的文件.在某些方面,库类似于文件夹.例如,打开库时将看到一个或多个文件.但与文件夹不同的是,库可以收集存储在多个位置中的文件.这

电脑中进行磁盘阵列RAID配置的详细步骤

  电脑中进行磁盘阵列RAID配置的详细步骤          1.按照屏幕下方的虚拟磁盘管理器提示,在VD Mgmt菜单(可以通过CTRL+P/CTRL+N切换菜单),按F2展开虚拟磁盘创建菜单; 2.在虚拟磁盘创建窗口,按回车键选择"Create New VD"创建新虚拟磁盘; 3.在RAID Level选项按回车,可以出现能够支持的RAID级别,RAID卡能够支持的级别有RAID0/1/5/10/50,根据具体配置的硬盘数量不同,这个位置可能出现的选项也会有所区别,选择不同的级别

开源堡垒机GateOne的安装、配置笔记(详细步骤)

  GateOne简介 GateOne是一款基于HTML5的开源终端模拟器/SSH客户端,同时内置强大的插件功能.它自带的插件使其成为一款令人惊艳的SSH客户端,但是,它可以用于运行任何终端应用.用户可以将GateOne嵌入其他应用程序从而提供各类终端访问界面,它也支持各类基于Web的管理界面--后面的大家自己看吧~~ 因为内部临时需要这么一套系统,所以搜搜查查,搞定了系统部署,使用pam认证的配置,做了个简单的管理界面. GateOne部署 系统初始化是使用CentOS 6.5 Mini x6

运行Varnish各参数配置的详细说明

风信网(ithov.com)原创文章:本文主要针对Varnish运行的参数配置进行详细的说明,包括Varnish指令.配置Varnish运行脚本及管理Varnish运行日志三个方面,通过深. varnishd指令 &http://www.aliyun.com/zixun/aggregation/37954.html">nbsp;   varnish启动的命令是/usr/local/varnish/sbin/varnishd.此命令参数较多,用法比较复杂,在命令行执行"/u

c语言-请求帮我详细解释下这个程序,谢谢了

问题描述 请求帮我详细解释下这个程序,谢谢了 #include #include #define uchar unsigned char #define uint unsigned int #define WCOMM XBYTE[0x0000] #define RCOMM XBYTE[0x0001] #define WDATA XBYTE[0x0002] #define RDATA XBYTE[0x0003] void BusyWait() { while((RCOMM & 0x80) != 0

builder-麻烦大家帮我详细解释下下面这段与串口交互的代码,谢谢!

问题描述 麻烦大家帮我详细解释下下面这段与串口交互的代码,谢谢! void __fastcall TfrmPatient::edtDosageDblClick(TObject *Sender) { //read comm data,then set in edtDosage edit //open com port HANDLE hCom = CreateFile(g_ConfigManager.sComPort.c_str(),GENERIC_WRITE,0,NULL,OPEN_EXISTIN

mfc-为什么 0x1f5是win+m呢,请给出详细解释,谢谢

问题描述 为什么 0x1f5是win+m呢,请给出详细解释,谢谢 CWnd* pWnd = CWnd::FindWindow(TEXT(""Shell_TrayWnd"")NULL);pWnd->SendMessage(WM_HOTKEY0X1F5); 解决方案 这是windows规定的,没有为什么.

java 正则表达式-这条java中的替换字符串的正则表达式是什么意思?能不能详细解释一下

问题描述 这条java中的替换字符串的正则表达式是什么意思?能不能详细解释一下 replaceAll("([^u4e00-u9fa5]{1})([^u4e00-u9fa5]{1})", "$2") 解决方案 在计算机科学中,是指一个用来描述或者匹配一系列符合某个句法规则的字符串的单个字符串.在很多文本编辑器或其他工具里,正则表达式通常被用来检索和/或替换那些符合某个模式的文本内容.许多程序设计语言都支持利用正则表达式进行字符串操作.例如,在Perl中就内建了一个功能