规范化之路(一) Checkstyle插件安装使用

随着代码越来越多,是时候对自己的代码进行规范化了

Checkstyle插件安装

1.离线包下载地址
https://sourceforge.net/projects/eclipse-cs/
或可以在csdn下载(123456, 版本号: 8.7.0.201801131309)
解压后直接放到dropins文件夹即可

2.在线安装
Help --> Install New Software
http://eclipse-cs.sourceforge.net/update

3.项目激活CheckStyle
右键项目 --> Checkstyle --> Activate Checkstyle

注意: Checkstyle是一个编码规范工具,结合eclipse的格式化,可以基本保持一定的统一风格,但是光靠这些还不够,需要平时积累编码规范,形成统一编码风格,达到所有人写的代码都像是一个人写出来一样.

使用总结:

(一).使用后,默认使用Google的Checkstyle规范,Google的缩进规范是2个空格,因此需要修改formatter,让eclipse的Ctrl+Shift+F格式化时使用2个空格(默认是tab的4位),这里要修改的不只是java的formatter,xml的需要的话也需要修改,我在使用lo4j2.xml格式化时Checkstyle就会报格式不正确,具体要修改可根据实际情况,如下图

(二).关于import的包顺序问题,Google的规范是按a-z字母顺序排序的,所以在eclipse进行Checkstyle格式化的时候,也会报代码不符合规范,因为eclipse的排序规则是先把Window->Preferences->Java->Code->Style->Organize Imports里的排在import前面,然后再按a-z排序,因此为了符合Google规范,最后把Organize Imports的所有项都移除,才不报不符合规范的提醒.

(三).一些异常提示及解决

1.<p> 标签应在第一个字符之前，紧邻后者，之间不允许有空格。

这是在获取json官网的java包,放到项目,提示的,原因是注释里面只有<p>标签,而没有</p>结束标签导致的提示,加上即可.

2.Javadoc 第 0 个字符解析错误。解析 JAVADOC_TAG ，详情： no viable alternative at input ' *'

这是因为@throws前面没有空行,加上空行即可.

规范化之路(一) Checkstyle插件安装使用相关推荐

在eclipse上Checkstyle的安装和使用
1. 概述随着中心的代码规范的建立和实施,项目组对代码规范要求,以及软件工程师们对自身代码的编写规范重要性的认知,"代码规范"已经成为了中心的一个"热词".然 ...
eclipse中CheckStyle的安装和使用
1. 概述随着中心的代码规范的建立和实施,项目组对代码规范要求,以及软件工程师们对自身代码的编写规范重要性的认知,"代码规范"已经成为了中心的一个"热词".然 ...
Eclipse插件CheckStyle的安装和使用
转载自:http://www.cnblogs.com/lanxuezaipiao/p/3202169.html CheckStyle是SourceForge下的一个项目,提供了一个帮助JAVA开发人员 ...
Eclipse中的checkstyle插件
一.Checkstyle工具 Checkstyle是一款检查Java程序源代码样式的工具,它可以有效的帮助我们检视代码以便更好的遵循代码编写标准. 官方地址:http://checkstyle.sou ...
Maven（一）Maven及插件安装
2012年的时候,我准备下载Spring框架的源码及项目看看,没想导入Eclipse报错,于是开启了Maven学习之路.继而突然一瞬间发现,许多牛B的项目都变成了Maven项目了. 官网http ...
eclipse mysql生成实体类_Eclipse实现数据库反向生成实体类（pojo）-------（插件安装和实现步骤的说明）...
一.插件安装 1.下载插件: http://jaist.dl.sourceforge.net/sourceforge/jboss/HibernateTools-3.2.4.Beta1-R2008103 ...
Eclipse中使用Checkstyle,checkstyle插件检查java代码的自定义配置文件：
摘要:近来项目组在搞代码检查,所以领导让把checkstyle这个插件搞明白,现在我把我们写的自定义的checkstyle.xml文件记录一下,以便大家可以一起使用: 一:要使用checkstyle插 ...
IDEA 2022 常用插件安装与全局配置教程大全
IDEA 2022 常用插件安装与全局配置教程大全文章目录 IDEA 2022 常用插件安装与全局配置教程大全一. 安装必备插件 1. Codota 代码智能提示插件 2. ...
Maven及插件安装
2012年的时候,我准备下载Spring框架的源码及项目看看,没想导入Eclipse报错,于是开启了Maven学习之路.继而突然一瞬间发现,许多牛B的项目都变成了Maven项目了. 官网http:// ...

规范化之路(一) Checkstyle插件安装使用

规范化之路(一) Checkstyle插件安装使用相关推荐

最新文章

热门文章