欢迎来到天天文库
浏览记录
ID:15928040
大小:186.00 KB
页数:16页
时间:2018-08-06
《checkstyle使用手册-eclipse-maven》由会员上传分享,免费在线阅读,更多相关内容在行业资料-天天文库。
1、两个Java代码检查工具PMD---它会对代码中的如下部分进行检查: 未使用的本地变量 空的catch块 未使用参数 空if语句 重复的import语句 未使用的私有方法 可能是Singletons的类 短/长变量及方法名字安装方法:先下载插件(附件中),安装方法如下:打开Myeclipse->Help->Searchfornewfeaturestoinstall->newArchivedsite->选择下载的包(附件中有)->安装->重启Myeclipse->完成 Chec
2、kStyle---检查如下部分: Javadoc注释 命名约定 标题 Import语句 体积大小 空白 修饰符 块 混合检查(包活一些有用的比如非必须的System.out和printstackTrace) 它们的作用 不像PMD,Checkstyle能够检查Javadoc注释;但是PMD提供了一项叫作CPD的很有用的功能,它检查代码的拷贝粘贴部分。我使用PMD找到的最频繁的错误是未使用的import语句,未使用的私有变量以及意外重复拼写。Checkstyle可以发现更
3、多的错误。包括漏掉的Javadoc注释,超过80个字符的行、不合约定的变量名、用tab来代替空格等等。两个工具都允许创建自定义的规则。 如果想在你的组织中使用它们中的一个,Checkstyle似乎更好一些:它检查公司编码约定的大多数项目。如果增强代码质量是主要目标,那PMD是一个好的选择. 安装方法:打开Myeclipse->Help->Searchfornewfeaturestoinstall->new Remotesite->输入URL:http://eclipse-cs.source
4、forge.net/update->安装->重启Myeclipse->完成CheckStyle使用手册介绍CheckStyle是SourceForge下的一个项目,提供了一个帮助JAVA开发人员遵守某些编码规范的工具。它能够自动化代码规范检查过程,从而使得开发人员从这项重要,但是枯燥的任务中解脱出来。CheckStyle默认提供一下主要检查内容: •Javadoc注释 •命名约定 •标题 •Import语句 •体积大小 •空白 •修饰符 •块 •代码问题 •类设计 •混合检
5、查(包活一些有用的比如非必须的System.out和printstackTrace) 从上面可以看出,CheckStyle提供了大部分功能都是对于代码规范的检查,而没有提供象PMD和Jalopy那么多的增强代码质量和修改代码的功能。但是,对于团队开发,尤其是强调代码规范的公司来说,它的功能已经足够强大。Eclipse插件安装和使用步骤一:http://sourceforge.net/projects/checkclipse/下载checkstyle的eclipse插件checkclipse。下
6、载后,将包放入eclipse的plugins文件夹下,然后重启eclipse。在Windows—>preferences下找到checkclipse。如下图:勾选SetProjectDirasCheckjstyleBasedir步骤二:右键选中你要进行checkstyle的项目文件,选择“properties”。如下图:勾选EnableCheckstyle和SetProjectClassLoader.然后再CheckstyleConfiguraionFile中选择项目中checkstyle的配置
7、文件。这里我把配置文件时放置在项目根目录下,所以点击右侧“Browse”按钮,在项目根目录下选择该文件。按“OK”按钮。这样整个项目的代码将根据配置文件中设置的原则进行出错提示.结果如下图:由图可知对不符合代码规范的代码会有错误提示,并且有提示信息。Maven插件安装和使用首先,修改要检查代码库top级的pom.xml文件,在build部分配置CheckStyle的Maven插件,以便于下载安装对应版本的插件(Maven会自动从其镜像库中下载),方法如下:Java代码 1.
8、2. ... 3. 4. 5. 6. org.apache.maven.plugins 7. maven-checkstyle-plugin 8. 2.3 9. 10. 11. <
此文档下载收益归作者所有