文档章节

项目编码规范

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
腾讯 Web UI 解决方案 QMUI Web 正式回迁开源

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

kayo5994
2017/08/25
3.6K
6
lindexi/EncodingNormalior

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

lindexi
2017/10/20
0
0
ReactNative项目实践编码规范

说明 此为无线前端开发团队遵循和约定的开发规范,旨在保持项目代码的整洁、易读、和一致性,更容易被理解和维护。对待规范,要严格遵守;对待风格,要懂得尊重。 要求 在本开发规范中,使用...

芒言
06/05
0
0
Koa2学习系列11规范与部署——制定合适的团队规范,提升开发效率-

规范与部署 懒人推动社会进步。 本篇中,我们会讲述三个知识点 定制书写规范 开发环境运行 如何部署运行 定制书写规范 文中所说的书写规范,仅供参考,非项目必需。 随着 流行, 编码规范已经...

大灰狼的小绵羊哥哥
昨天
0
0

没有更多内容

加载失败,请刷新页面

加载更多

CentOS7防火墙firewalld操作

firewalld Linux上新用的防火墙软件,跟iptables差不多的工具。 firewall-cmd 是 firewalld 的字符界面管理工具,firewalld是CentOS7的一大特性,最大的好处有两个:支持动态更新,不用重启服...

dingdayu
今天
1
0
关于组件化的最初步

一个工程可能会有多个版本,有国际版、国内版、还有针对各种不同的渠道化的打包版本、这个属于我们日常经常见到的打包差异化版本需求。 而对于工程的开发,比如以前的公司,分成了有三大块业...

DannyCoder
今天
2
0
Spring的Resttemplate发送带header的post请求

private HttpHeaders getJsonHeader() { HttpHeaders headers = new HttpHeaders(); MediaType type = MediaType.parseMediaType("application/json; charset=UTF-8"); ......

qiang123
昨天
3
0
Spring Cloud Gateway 之 Only one connection receive subscriber allowed

都说Spring Cloud Gateway好,我也来试试,可是配置了总是报下面这个错误: java.lang.IllegalStateException: Only one connection receive subscriber allowed. 困扰了我几天的问题,原来...

ThinkGem
昨天
27
0
学习设计模式——观察者模式

1. 认识观察者模式 1. 定义:定义对象之间一种一对多的依赖关系,当一个对象状态发生变化时,依赖该对象的其他对象都会得到通知并进行相应的变化。 2. 组织结构: Subject:目标对象类,会被...

江左煤郎
昨天
4
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部