文档章节

项目编码规范

b
 black-c
发布于 2017/08/19 21:47
字数 577
阅读 15
收藏 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
吐槽一下我公司的项目开发流程

初入开发世界,吐槽一下我公司的项目开发流程的问题,我只参与编码过程,所以,我有什么说的不对,也请指出: 项目前期,需求分析不够,对各个功能点的取舍不定,系统设计目标也不明确,还有...

OSC首席键客
2013/07/18
4K
60
每个TS项目的编码规范

每个项目的编码都需要规范起来了,为接下来的代码审查 code review做准备, 编码规范文档,目前只需要按照 文档里面写的要求来即可。 如果有啥更好的建议可以提

寰宇天
2017/10/16
3
1
程序员你为什么这么累【续】:编码习惯之参数校验和国际化规范

程序员你为什么这么累【续】:编码习惯之参数校验和国际化规范 程序猿DD | 博客2017-09-097 阅读 校验参数编码国际化程序员 导读: 程序员你为什么这么累? 我的编码习惯 - 接口定义 我的编码...

程序猿DD | 博客
2017/09/09
0
0
ReactNative项目实践编码规范

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

芒言
06/05
0
0

没有更多内容

加载失败,请刷新页面

加载更多

使用form表单同时实现上传文件和提交文本数据

使用form表单同时实现上传文件和提交文本数据,此示例中在后台将文件上传到阿里的oss存储服务器中 申请oss相关账号: endpoint = "http://oss-cn-qingdao.aliyuncs.com"; accessKeyId = "key"...

貔貅叔
4分钟前
0
0
结合实际场景谈一谈微服务配置

作为 Nacos 5W1H 的系列文章,本文将围绕“Where”,讲述 Nacos 配置管理的三个典型的应用场景: 数据库连接信息 限流阈值和降级开关 流量的动态调度 上一篇:Nacos帮我解决了什么问题? 数据...

阿里云云栖社区
6分钟前
0
0
在Windows安装运行Kafka

https://www.cnblogs.com/flower1990/p/7466882.html 一、安装JAVA JDK 1、下载安装包 http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html 注意:根据3......

洛水
8分钟前
0
0
插件

sftp Bracket Pair Colorizer Guides Auto Rename Tag Chinese (Simplified) Language Pack for Visual Studio Code...

dragon_tech
9分钟前
0
0
Missing Number(leetcode268)

Given an array containing n distinct numbers taken from 0, 1, 2, ..., n, find the one that is missing from the array. Example 1: Input: [3,0,1]Output: 2 Example 2: Input: [9,6......

woshixin
13分钟前
0
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部