- 浏览: 1510742 次
- 性别:
- 来自: 深圳
文章分类
- 全部博客 (595)
- Java咖啡厅 (208)
- IT杂侃 (23)
- 程序员笑话 (7)
- 我的后现代文学 (1)
- WEB编程 (116)
- 软件评测 (8)
- 操作系统 (3)
- 炫目Ruby (2)
- 行业知识 (7)
- 我的动漫情结 (6)
- 其他 (8)
- Window DIY (6)
- 古文学 (3)
- 转载文章 (2)
- IT百科 (7)
- 动态网页Active (1)
- 文档 (1)
- 设计理论 (11)
- .NET 快速开发 (18)
- 英语学习 (6)
- 网站分析 (2)
- 开源软件 (4)
- 数据库 (28)
- 笔记 (4)
- 源代码共享 (8)
- IT人物 (2)
- 软件管理 (10)
- 小说创作 (0)
- 大众软件 (12)
- 网站评论 (3)
- 小虾乱说 (10)
- 游戏 (8)
- 心情 (3)
- 娱乐休闲 (2)
- Delphi编程 (1)
- PHP编程 (4)
- 中间件 (2)
- 移动开发 (2)
- Office应用 (2)
- Photoshop (1)
- Eclipse (5)
- 面试题 (1)
- 手机评测 (0)
- VBScript (1)
- WEB前端-EXT (3)
- 吐槽 (1)
- Java咖啡厅 Ibatis (1)
- javascript Ext (1)
- jquery ui (1)
- require (1)
- WEB编程 Javascript (1)
- jquery (1)
- Swing (1)
- 分布式 (1)
最新评论
-
zhangjihao:
28. 下面哪个Set是排序的? A. LinkedHas ...
Java面试题(选择题) -
zhangthe9:
ICMP报文被封装在IP包里,也就是说他是由IP协议承载的,从 ...
Java面试题(选择题) -
zhunengfei:
真的假的?
自已写的jquery ui框架 -
white_crucifix:
少年,发烫是所有智能手机的特点,而莫名发烫是所有安卓手机的特点 ...
【吐槽】三星手机的OS是一砣屎 -
suzu88:
试了一下,可以用。如果美化一下控件和窗体更有意思。
一个用XML构建Swing视图的框架
CheckStyle是一个很有趣的开源框架,他可以帮助检查Java代码中的代码规范,传统的代码检查是一种很无聊的工作,而且无法全面的去检查,而大公司一般都会定期的进行代码检查,不想做也不行,怕被别人找麻烦。而CheckStyle就是一个可以帮助我们自动去检查Java代码的工具,替我们分担了不少无聊(但也是重要)的工作。
CheckStyle是一个高度可配置(通过XML配置需要检查的规范),他不但是免费的软件,而且还是一个开源的软件
在CheckStyle的软件包里面还包括很多有名的代码规范,如Sun Code Conventions (Sun公司的代码规范),其他的例子其实也都是有名的代码规范。
CheckStyle可以检查你的代码中的很多方面,以前它只是用来检查规范,但在版本3后,很多的规则被添加进来,以致它开始可以用来检查Java代码中的一些程序缺陷。
CheckStyle的源程序以及编译好的软件包可以在SourceForge里面下载,下载的地址是:
http://sourceforge.net/project/showfiles.php?group_id=29721
你也可以从SVN上去获取CheckStyle最新的代码
相关工具:
CheckStyle可以在命令行或者Ant里运行
另外,Eclipse和NetBean上都可以找到CheckStyle的插件
CheckStyle最新的版本是5.1
CheckStyle的配置
CheckStyle的配置主要配置哪些规则会被应用到代码的检查中,规则用XML来配置,所以规则都会添加在Root 的Module里面,也就是说Root是最根本的级别。
TreeWalker:在TreeWalker里面定义的Module会在轮流在源码所以解析成的语法树里面去验证规则
接下来是一个典型的配置文档
<module name="Checker"> <module name="JavadocPackage"/> <module name="TreeWalker"> <module name="AvoidStarImport"/> <module name="ConstantName"/> <module name="EmptyBlock"/> </module> </module> |
JavadocPackage是一个很奇怪的检查,他检查文件的目录上是不是有一个package-info.java,一个是Java1.5后的一个新功能,目录是让所有的包都有一个共同的注释。
Module TreeWalker里面有三个子Module,分别是AvoidStarImport(不允许*导入,也就是类要一个一个导),ConstantName(变量命名规则,这个规则基本上是通用的),EmptyBlock。
对于每一个Module,CheckStyle都会加载一个规则类来处理,以下是几条CheckStyle加载类的规则
1. 直接导入,如果是已经定义了包名的规则类,CheckStyle直接把这个包与类名导入
2. 如果没有定义包名,则会自动在包com.puppycrawl.tools.checkstyle.checks找到相应的类
3. 会自动在类名后自动加Check,如果类名后没有Check的话
Module的属性
我们是可以在Module里面定义属性的,这样我们才可以更好的定义规则。
比如:
<module name="MethodLength"> <property name="max" value="60"/> </module>
这个Module表示检查方法的长度不可以超过60行,这里定义了一个max属性
TreeWalker下的规则
TreeWalker下的规则都是和语法树有关的规则
比如:
<module name="MethodLength"/>
这里是检查方法的长度,方法属于语法树的范围,默认的属性是{METHOD_DEF, CTOR_DEF} (构造方法与普通方法都检查),如果改成这样
<module name="MethodLength"> <property name="tokens" value="METHOD_DEF"/> </module> <module name="MethodLength"> <property name="tokens" value="CTOR_DEF"/> <property name="max" value="60"/> </module> |
这样就会把普通方法与构造方法分开来检查
发表评论
-
原创程序- Web版数据库管理
2017-11-15 00:39 1185这是我自已写的Web版的数据库管理工具,主要是依赖于JDBC ... -
Eclipse创建Web项目
2017-07-29 10:53 7831. 打开创建Web项目的对话框 2 ... -
Ant常用的命令
2016-06-16 13:31 13521. 使用Ant生成War包: <war ... -
在Eclipse上使用Ant发布项目
2015-10-17 15:03 1378这里笔者使用是Eclip ... -
Resin中增加一个虚拟目录的方法
2015-09-13 12:53 1124打开resin.config 找到到<h ... -
一个用XML构建Swing视图的框架
2015-09-06 23:12 2609平常想用Java写一些 ... -
Eclipse常见问题
2015-08-24 19:41 741如果Eclipse被强制关闭时,Tomcat可能没有 ... -
Spring Tools Suite 入门教程
2015-05-09 09:15 0Spring Tools Suit,这里简称STS,是 ... -
使用FTP的方法
2015-03-01 17:49 10211. FlashFXP 收费的软件,但是比较好 ... -
关于Spring
2015-02-16 14:46 2007Spring是一个轻量级J2EE框架。 Sp ... -
用Java实现发送邮件到163
2014-12-28 14:50 3859/* 在java版经常看到有人问如何用javamai ... -
Hibernate入门
2014-12-27 01:34 931前言 使用面向对象的语言和关系型的数据库,开 ... -
修改date.toLocaleString()的警告
2014-10-15 11:31 2556我们在写程序的时候,经常要查看时间,所以我们经常会用到 ... -
Java基础题 -- 简述题
2014-04-26 13:44 729(1)简述Java的运行机制 答案:Java语言根 ... -
Java基础题 -- 填空题
2014-04-26 10:00 18911. ______是一个抽象的计算机,和实际的计算机一样, ... -
FreeMaker入门
2014-04-07 19:51 1018第一章 简介 1 什么是FreeMaker ... -
jdk8 新语法
2014-04-01 23:32 1286import java.util.*; public ... -
MyBatis 入门
2014-03-27 23:31 1726每个MyBatis的中心是SqlSessionFact ... -
Jetty入门
2014-02-26 23:48 1581Jetty是一个简易的WebServer框架,使用 ... -
用Swing做的H2管理器
2014-02-24 23:07 1571MainFrame 继承了 JFrame , 增加c ...
相关推荐
checkstyle 中文文档checkstyle 中文文档checkstyle 中文文档checkstyle 中文文档checkstyle 中文文档checkstyle 中文文档checkstyle 中文文档checkstyle 中文文档
总之,CheckStyle中文文档是Java开发者不可或缺的参考资料,它能帮助我们编写更高质量、更易于维护的代码,同时也提升了团队之间的沟通效率,因为大家都遵循同一套编码标准。无论你是初学者还是经验丰富的开发者,都...
以下是对Checkstyle中文帮助文档中的主要知识点的详细说明: 1. **概述**:Checkstyle提供了一套可配置的规则,用于检查代码中的各种风格问题,如命名约定、注释规范、代码结构等。它通过读取一个XML配置文件来确定...
CheckStyle安装、使用、配置 的整理文档, 关于checkStyle的所有配置选项的解释
Excel格式的Checkstyle5.5中文手册。
Checkstyle是一款强大的静态代码分析工具,用于检查Java源代码是否遵循特定的编码规范和最佳实践。MyEclipse作为一款流行的Java集成开发环境(IDE),提供了与Checkstyle集成的功能,帮助开发者在编码阶段就能发现...
checkstyle配置文档Checkstyle的检查项配置详解
1. **获取配置文件**:可以从Checkstyle官方网站获取预设的配置,如“sun_checks.xml”,也可以根据项目需求定制自己的配置。 2. **集成Checkstyle**:将Checkstyle添加到项目构建工具中,如Maven或Gradle。在Maven...
Checkstyle 是一个强大的静态代码分析工具,主要用于检查 Java 代码是否符合特定的编码规范和样式。这个插件广泛应用于 Maven 项目中,帮助开发者确保代码的一致性和质量。以下是关于如何在 Maven 项目中配置和使用 ...
在本文中,我们将深入探讨如何在Eclipse集成开发环境中安装并使用CheckStyle插件,以提升代码质量和遵循统一的编程规范。CheckStyle是一款强大的静态代码分析工具,它可以帮助开发者检查代码中的潜在问题,确保代码...
"Checkstyle 4.3 中文手册"是Checkstyle的一个较旧版本的手册,但它仍然提供了大量有价值的信息。手册中会包含每个检查项的详细描述、配置选项以及如何解决违规的建议。比如,它可能会介绍`TreeWalker`检查器,这是...
中文提示版CheckStyle
"CheckStyle使用详解" CheckStyle是一款功能强大且操作简单的代码检查工具,它可以与Ant结合使用,并且是Open Source的,这意味着用户不需要担心收到律师函。CheckStyle的主要功能是检查Java代码的格式和风格,以...
CheckStyle Xml 示例文档分析 CheckStyle 是一个流行的 Java 代码检查工具,通过检查 Java 代码的格式、结构和语法错误来提高代码的质量和可维护性。CheckStyle Xml 文件是 CheckStyle 工具的配置文件,用于定义...
Checkstyle 是一款强大的Java编程规范检查工具,它旨在帮助开发者遵循特定的编码标准和最佳实践。这个工具在软件开发过程中扮演着重要的角色,因为它能够自动检测源代码中的潜在问题,如不一致的命名约定、未使用的...
**IDEA CheckStyle离线安装包** IntelliJ IDEA,简称IDEA,是广大开发者广泛使用的Java集成开发环境。它以其高效、智能的代码编辑、强大的调试工具和丰富的插件库而深受喜爱。CheckStyle是一款静态代码分析工具,...
虽然阿里巴巴的规范很全面,但每个项目可能有自己的特殊需求。Checkstyle允许你自定义配置,以适应项目特有的编码风格。你可以通过修改配置文件来添加、删除或修改检查规则。 5. **持续集成**: 将Checkstyle集成...
CheckStyle是一款著名的开源代码质量检查工具,主要用于Java项目的编码...通过解压并研究`checkstyle-checkstyle-8.26.zip`,开发者可以深入了解其工作原理,并根据自己的需求定制规则,打造更高质量的Java应用程序。