文档章节

项目编码规范

b
 black-c
发布于 2017/08/19 21:47
字数 577
阅读 13
收藏 0
点赞 0
评论 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 ⋅ 1

lindexi/EncodingNormalior

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

lindexi ⋅ 2017/10/20 ⋅ 0

腾讯 Web UI 解决方案 QMUI Web 正式回迁开源

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

kayo5994 ⋅ 2017/08/25 ⋅ 6

编码规范集锦

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

oschina ⋅ 2013/04/08 ⋅ 23

软件项目质量保证:编码规范

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

MeteorSeed ⋅ 2016/08/29 ⋅ 0

基于koajs的web项目构建-心得篇

根据 基于koajs的web项目构建-入门篇 所描述的,建立了项目的基本目录结构,接下来的工作便是编码,编译,测试,发布。做为这些工作,每一项工作都有自己的学问,针对这三项工作的技巧分析文...

唯慕清风 ⋅ 2016/09/20 ⋅ 0

程序员你为什么这么累【续】:编码习惯之参数校验和国际化规范

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

程序猿DD | 博客 ⋅ 2017/09/09 ⋅ 0

ReactNative项目实践编码规范

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

芒言 ⋅ 06/05 ⋅ 0

gbk页面ajax表单提交中文乱码的问题

由于以前的项目文件编码一直很规范,因为在刚开始学编程的时候老师们都一再强调编码的问题,所以一直用的都是utf-8编码,so基本没有遇到过编码的问题了。 现在维护的项目很老,代码是10年的,...

清天君 ⋅ 2016/11/29 ⋅ 0

请给代码多留一些空间

最近在几个不同的团队中发现他们的编码规范中对空格的用法大不相同。这激起了我的好奇心,因为我一直觉得,对于代码格式中的空格的使用,应该有一个大家都公认的最好的习惯。但是在现实开发中...

oschina ⋅ 2014/06/09 ⋅ 46

没有更多内容

加载失败,请刷新页面

加载更多

下一页

从 Confluence 5.3 及其早期版本中恢复空间

如果你需要从 Confluence 5.3 及其早期版本中的导出文件恢复到晚于 Confluence 5.3 的 Confluence 中的话。你可以使用临时的 Confluence 空间安装,然后将这个 Confluence 安装实例升级到你现...

honeymose ⋅ 今天 ⋅ 0

用ZBLOG2.3博客写读书笔记网站能创造今日头条的辉煌吗?

最近两年,著名的自媒体网站今日头条可以说是火得一塌糊涂,虽然从目前来看也遇到了一点瓶颈,毕竟发展到了一定的规模,继续增长就更加难了,但如今的今日头条规模和流量已经非常大了。 我们...

原创小博客 ⋅ 今天 ⋅ 0

MyBatis四大核心概念

本文讲解 MyBatis 四大核心概念(SqlSessionFactoryBuilder、SqlSessionFactory、SqlSession、Mapper)。 MyBatis 作为互联网数据库映射工具界的“上古神器”,训有四大“神兽”,谓之:Sql...

waylau ⋅ 今天 ⋅ 0

以太坊java开发包web3j简介

web3j(org.web3j)是Java版本的以太坊JSON RPC接口协议封装实现,如果需要将你的Java应用或安卓应用接入以太坊,或者希望用java开发一个钱包应用,那么用web3j就对了。 web3j的功能相当完整...

汇智网教程 ⋅ 今天 ⋅ 0

2个线程交替打印100以内的数字

重点提示: 线程的本质上只是一个壳子,真正的逻辑其实在“竞态条件”中。 举个例子,比如本题中的打印,那么在竞态条件中,我只需要一个方法即可; 假如我的需求是2个线程,一个+1,一个-1,...

Germmy ⋅ 今天 ⋅ 0

Springboot2 之 Spring Data Redis 实现消息队列——发布/订阅模式

一般来说,消息队列有两种场景,一种是发布者订阅者模式,一种是生产者消费者模式,这里利用redis消息“发布/订阅”来简单实现订阅者模式。 实现之前先过过 redis 发布订阅的一些基础概念和操...

Simonton ⋅ 今天 ⋅ 0

error:Could not find gradle

一.更新Android Studio后打开Project,报如下错误: Error: Could not find com.android.tools.build:gradle:2.2.1. Searched in the following locations: file:/D:/software/android/andro......

Yao--靠自己 ⋅ 昨天 ⋅ 0

Spring boot 项目打包及引入本地jar包

Spring Boot 项目打包以及引入本地Jar包 [TOC] 上篇文章提到 Maven 项目添加本地jar包的三种方式 ,本篇文章记录下在实际项目中的应用。 spring boot 打包方式 我们知道,传统应用可以将程序...

Os_yxguang ⋅ 昨天 ⋅ 0

常见数据结构(二)-树(二叉树,红黑树,B树)

本文介绍数据结构中几种常见的树:二分查找树,2-3树,红黑树,B树 写在前面 本文所有图片均截图自coursera上普林斯顿的课程《Algorithms, Part I》中的Slides 相关命题的证明可参考《算法(第...

浮躁的码农 ⋅ 昨天 ⋅ 0

android -------- 混淆打包报错 (warning - InnerClass ...)

最近做Android混淆打包遇到一些问题,Android Sdutio 3.1 版本打包的 错误如下: Android studio warning - InnerClass annotations are missing corresponding EnclosingMember annotation......

切切歆语 ⋅ 昨天 ⋅ 0

没有更多内容

加载失败,请刷新页面

加载更多

下一页

返回顶部
顶部