代码格式化规范及设置方法（不符合规范禁止提交）

最新推荐文章于 2023-02-09 21:28:56 发布
最新推荐文章于 2023-02-09 21:28:56 发布
阅读量2.3k 收藏 1
点赞数 1
分类专栏： Git操作 android开发 文章标签： git
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_39308198/article/details/79414648
版权
为了提高代码维护性和开发效率，该博客介绍了如何基于github的checkstyle标准，使用python脚本和git hook在commit时自动检测和格式化代码。详细步骤包括：安装checkstyle-idea插件，配置checkstyle与codeStyle的关联，以及设置git pre-commit脚本。通过这些步骤，不符合规范的commit将被阻止。
摘要由CSDN通过智能技术生成

目的

为了能够更好地维护代码，提高开放效率，特定此规范。

概述

规范采用github上checkstyle的格式化标准，并使用python脚本和git hook方式，在git commit时，对代码进行格式化检测，如果检测到不符合规范的代码，commit失败。开发人员可以通过checkStyle插件查看代码提示。

资料下载

链接:https://pan.baidu.com/s/1qZsDGio 密码: dv3j

插件安装步骤

  1. 设置android studio 、git、python（2.x版本） 等开发环境，这里要注意的是python脚本需要依赖python2.x版本。

  2. 安装checkstyle-idea插件，可以在线安装，也可以从本地安装（资料文件夹中已经下载好了）

最低0.47元/天 解锁文章
林霄
关注
  • 1
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
专栏目录
前端工程化之代码规范---ESLint + Prettier + husky + lint-staged代码规范全家桶
codingWeb的博客
11-07 1267
每个开发者都有自己的习惯，代码的风格也不尽相同，比如缩进的格数，结尾加不加分号,定义函数有没有空格，这些看似好像不起眼的风格，但在多人开发的时候，代码commit提交，可能就会出现一大片冲突，或者过多修改过的情况，对项目管理和维护是极其不友好的，而且在review，阅读项目代码的时候，一个项目中出现几种，甚至10几种的代码风格，我相信没人受得了这事，人都有一种惯性思维，习惯看一种风格，切换到其他风格可能需要适应一下，更别说人手一套风格的项目了，这肯定是不能接受的 ，这个问题很严重，必须得解决 ...
简单五步就给项目加一个commit 规范强制约束
weixin_44514665的博客
11-20 1538
简单五步就给项目加一个commit 规范强制约束 校验成功的运行效果如下： 前言 项目的提交备注五花八门,以至于后期不好追踪排查问题,强烈推荐大家在项目中加上commit 规范约束,能够防止不规范代码被 commit、push、merge 等等。方便你我他 ！ 实现步骤 首先,安装 husky husky它可以方便我们在项目中添加 git hooks,针对以下都是以 @6+版本为例 npm i -D husky 执行 npx husky install 命令,该命令会创建 .husky/ 目录,
React Native - git commit 时自动检查并格式化代码
流星叶雨的博客
01-06 1157
最近公司项目由纯原生转向React Native，对纯原生开发来说，刚开始接触js真是一个头两个大，各种编码风格、语法格式把几个同事搞得云里雾里，代码混乱得一塌糊涂，每次代码拉下来IDE就是各种警告+错误。 笔者查了一些资料，索性直接将代码格式统一，在commit前对代码重新格式化并二次检查，如果格式不符合规则，将无法commit成功。 主要用到的工具则是eslint + prettier + husky。 写下这篇文章主要也是给自己mark一下，以免后面忘记了又得重来一遍。 一、eslint e
Java后端项目IDEA配置代码规范检查，使用checkStyle实现
最新发布
QC班长的博客
02-09 5930
比如可以通过 CI 限制，例如在 forking-workflow 模式中设置在 Merge 时自动执行一个 Actions 来执行 Lint，对于不合格的 Merge Request 直接关闭掉不允许合并，以变相到达不合格代码进入主干的目的。打开file --> settings,找到Tools ,可以看到安装好的 checkstyle,Configuration File-->点击➕添加项目中的配置文件，选择checks/alibaba-checks.xml文件，输入名称，点击下一步，完成。
checkstyle.xml规约案例
qq_35148205的博客
12-03 681
checkstyle.xml 案例
利用Gitlab钩子实现代码规范管控
zp814337112的博客
04-09 5618
利用Gitlab钩子实现代码规范管控1、前言2、规范简介3、Gitlab钩子简介4、流程图5、实施步骤 1、前言 在一个开发团队中通常会碰到这样一个问题，那就是很多人的代码不够规范，导致可读性差甚至引发一些bug，然后就会有人出来制定代码规范了，制定完了开始推行，可是一段时间后却发现没人提了，于是代码又开始逐渐不够规范起来。那我们要怎么解决这个难题呢？那就需要引入一套强制规范要求的机制了，如果代码不够规范就不准提交到仓库里去，这样就不会让规范慢慢失去味道了，而是会一直强制执行下去。这就是本文将会提到的，利用
后端代码规范
qq_43648142的博客
12-28 585
命名风格 代码命名不能以下划线或者美元符号开头或者结尾 代码命名不能以中文拼音或者中文拼音与英文混合方式 类名使用UpperCamCamelCase风格，但DO、PO、DTO、VO、BO等除外 方法名、参数名、变量名统一使用lowerCamelCase，必须遵守驼峰命名 常量名全部大写，单词间用下划线隔开 抽象类必须以Abstract或者Base开头，异常类必须以Exception结尾，测试 类以测试的类的名称开头Test结尾 类型与中括号紧挨相连标示数组 POJO类中布尔类型变量不要加is前缀 包名统一
Conventional Commits 规范约定式提交 1.0.0
11-07
**约定式提交(Conventional Commits)** 是一种用于在Git提交信息中添加标准化格式的规范，目的是为了提高代码库的可维护性和自动化工具的效率。它遵循一定的结构，使得提交信息更加清晰，易于理解，同时也方便了自动...
【大厂企业级项目架构】之项目搭建和代码规范
郊眠寺
09-21 1892
代码规范是前端项目架构的重要一环。为了避免篇幅过长，本篇先讲解了项目初始化阶段是如何使用来规范我们的代码的，同时使用来做提交前的代码校验。整理了75个JS高频面试题，并给出了答案和解析，基本上可以保证你能应付面试官关于JS的提问。有需要的小伙伴，可以点击下方卡片领取，无偿分享。
Python-Hypothesis是一个高级基于属性的Quickcheck风格特性的测试Python库
08-10
Hypothesis 是一个高级基于属性的 Quickcheck 风格特性的测试Python库
阿里Java代码规范
Kaptcha的学习
06-28 3351
代码规范一、编程规约(一) 命名风格(二) 常量定义(三) 代码格式(四) OOP 规约(五) 集合处理(六) 并发处理(七) 控制语句(八) 注释规约(九) 其它二、异常日志(一) 异常处理(二) 日志规约三、单元测试四、安全规约五、MySQL 数据库(一) 建表规约(二) 索引规约(三) SQL 语句(四) ORM 映射六、工程结构(一) 应用分层(二) 二方库依赖(三) 服务器 一、编程规约...
git commit 内容不合规，代码提交不上去，怎么办
wangqiaojie的博客
07-27 3740
git commit 内容提交不上去，怎么办，可以试试 git commit --amend 和 git reabase 来修改commit内容
git commit 提交规范之ESlint规范校验
mrhaoxiaojun的博客
11-12 6070
在软件开发过程中，代码风格检查（Code Linting）是保障代码规范和一致性的有效手段。过去，Lint 的工作一般在 CodeReview 或者 CI 的时候进行，但这样会导致问题的反馈链，浪费不必要的时间。因此，我们需要利用 Git 的 Pre Commit 钩子，将 Lint 过程放到开发者提交代码之前。 简介 简单介绍一下这三个工具： prettier 用来优化代码格式，比如缩进、空格、分号等等 husky可以用于实现各种 Git Hook。这里主要用到 pre-commit这个 hook，在.
CheckStyle提高代码质量
最美的路百转千回
06-16 7675
介绍 CheckStyle是SourceForge下的一个项目，提供了一个帮助JAVA开发人员遵守某些编码规范的工具。它能够自动化代码规范检查过程，从而使得开发人员从这项重要，但是枯燥的任务中解脱出来。 现在就来看看CheckStyle，从安装、checkstyle规范的编写及配置。安装CheckStyle插件 要使用 checkstyle 需要安装一个 插件 CheckStyle
checkstyle简单使用说明
mezheng的专栏
03-02 4677
checkstyle对检查代码规范问题的总结，虽然还不够只能，但已经比较强大。 1.Cyclomatic Complexity is X (max allowed is X).   问题说明：圈复杂度过高。所反映的是“判定条件”的数量。圈复杂度大说明程序代码可能质量低且难于测试和维护。   修改建议：降低判定条件的数量。对方法进行拆分。 2.Nested if-else depth is
checkStyle的使用
u012435167的博客
08-20 5766
checkStyle的使用 为了提高代码规范，保证代码注释的完整，打算修改类和方法的注释，让开发人员能够便捷高效的生成对应注释和说明，但是并不能强制开发人员在每个方法添加注释，无形之中会增加代码评审的工作量，显然这个方法是不可取的。 在一筹莫展之际，发现了一个集成插件：CheckStyle，可以通过xml的配置来实现代码的校验，校验的参数都是可以配置的，很适合在公司开发环境中集成。 废话不说，...
Checkstyle规则文档详细说明--style_template.xml
ladymorgana的博客
05-07 2601
<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE module PUBLIC "-//Puppy Crawl//DTD Check Configuration 1.3//EN" "http://www.puppycrawl.com/dtds/configuration_1_3.dtd"> <module name="C...
快速使用Checkstyle（一）
热门推荐
编码语言Codelang
04-15 1万+
快速使用Checkstyle（一）1.介绍Checkstyle是一种代码规约工具，可以帮助程序员编写符合编码标准的Java代码。使用Checkstyle可以自定义一些代码规范用于在编译中强制执行。CheckStyle默认使用的是Sun的编码规范。本文以8.8版本进行编写。参考资料：http://checkstyle.sourceforge.net/index.html例如：Sun：http://c...
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值