文档章节

项目编码规范

b
 black-c
发布于 2017/08/19 21:47
字数 577
阅读 14
收藏 0

本次教程,将简单介绍一下关于编程规范及代码格式方面的问题。

在开发之中,项目的编码规范是非常重要的,但是,仅仅只是提出规范而不去遵守,那也就毫无意义了。这时,我们就需要一些工具来辅助我们完成这件事。

下面我介绍一下怎样使用 check-style 对项目代码进行规范化管理。

CheckStyle是SourceForge下的一个项目,提供了一个帮助JAVA开发人员遵守某些编码规范的工具。它能够自动化代码规范检查过程,从而使得开发人员从这项重要,但是枯燥的任务中解脱出来。-- 引用自百度百科

各种IDE都对check-style提供了支持,本教程仅介绍在Idea中使用 check-style ,至于其他,大体上都是一样的。

首先,自然是安装插件,可以在Idea中打开 File > Settings > Plugins,搜索 check-style并进行安装:

输入图片说明

安装之后还需做一件事情,就是配置 check-style的验证规则:

输入图片说明

安装之后会默认提供 Sun checksGoogle checks。我使用的Checks文件是在 Google checks 基础上进行简单修改而成,大家可以根据自己情况使用公司的Checks文件或使用Google style。

安装 check-style并设置Checks规则后,就可以使用它来检测我们的代码了,当写了非规范的代码后,check style会给出如下的提示: 输入图片说明

当然,仅仅给出提示是不行的,我们还需设置Code style的scheme文件,用于在Idea中自动格式化代码;同样的,scheme文件我也是使用 Google style: 输入图片说明 配置好之后,在使用Idea时就会根据对应的style文件来格式化代码。还有一点需要注意的就是上图箭头所指位置,推荐在各个操作系统下都将 Line separator设置为 Unix and OS X 风格,不然可能会因为开发人员使用不同操作系统而导致一些问题,如: shell 脚本。

check-style的简单使用就介绍到这,等后面介绍使用Jenkins结合GitHub进行开发时,会介绍怎样配置Jenkins check-style 插件进行构建前置检查。

© 著作权归作者所有

共有 人打赏支持
b
粉丝 0
博文 5
码字总数 2383
作品 0
成都
代码规范的重要性之-为什么谷歌要执行严格的代码编写规范

我们在谷歌所做事情中另外一个让我感到异常有效、有用的制度是严格的编码规范。 在到Google工作之前,我一直认为编码规范没有什么用处。我坚信这些规范都是官僚制度下产生的浪费大家的编程时...

秦都李先生
2014/08/07
0
1
lindexi/EncodingNormalior

编码检测和修改工具 在开发中经常遇到编码不一致的文件,而如果这些文件包含需要显示的字符串,就会导致在乱码。所以需要一个工具可以自动检测工程、文件夹内所有文本的编码,并可以规范所有...

lindexi
2017/10/20
0
0
腾讯 Web UI 解决方案 QMUI Web 正式回迁开源

项目简介 QMUI Web 是一个专注 Web UI 开发,帮助开发者快速实现特定的一整套设计的框架。由腾讯广研 QMUI 团队出品。框架主要由一个丰富的 Sass 方法合集与内置的工作流构成。通过 QMUI Web...

kayo5994
2017/08/25
3.6K
6
编码规范集锦

真的不知道我的第一篇真正的文章应该以什么为主题。我最终选择了编码规范。 编码规范是什么? 简单说——编码规范是一种…规范。通过建立起一种通用的约定和模式,所有人都遵循,以此帮助打造...

oschina
2013/04/08
5.7K
23
软件项目质量保证:编码规范

原文出处:MeteorSeed 作为软件开发者,我们可以开发低等级的软件,但不能开发低质量的软件。所以,如何实施质量保证,是我们关注的主要问题之一,而编码规范则是实施质量保证的第一步。 编码...

MeteorSeed
2016/08/29
0
0

没有更多内容

加载失败,请刷新页面

加载更多

下一页

angular 解决其他电脑不能访问的问题。

ng serve --host 0.0.0.0 --disable-host-check

miaojiangmin
今天
1
0
优酷视频文件怎么转换格式

  以前在优酷上下载视频都只是在手机上观看,但随着科技的发展,对于视频的要求也逐渐增多,不再只是观看视频那么简单,在精彩的部分还会将其单独分割出来,然后进行视频剪辑,可以做出我们...

萤火的萤火
今天
0
0
数据结构:散列

在一个数据结构中查找key元素,用顺序查找、二分查找都需要经过一系列关键之比较才能查找到结果,平均查找长度与数据量有关,元素越多比较次数就越多。 如果根据元素的关键字就能知道元素的存...

京一
今天
0
0
Apache RocketMQ 正式开源分布式事务消息

近日,Apache RocketMQ 社区正式发布4.3版本。此次发布不仅包括提升性能,减少内存使用等原有特性增强,还修复了部分社区提出的若干问题,更重要的是该版本开源了社区最为关心的分布式事务消...

阿里云云栖社区
今天
30
0
使用JavaScript和MQTT开发物联网应用

如果说Java和C#哪个是最好的开发语言,无疑会挑起程序员之间的相互怒怼,那如果说JavaScript是动态性最好的语言,相信大家都不会有太大的争议。随着越来越多的硬件平台和开发板开始支持JavaS...

少年不搬砖老大徒伤悲
今天
0
0

没有更多内容

加载失败,请刷新页面

加载更多

下一页

返回顶部
顶部