【C/C++】 代码质量控制手段
问题引入
多人协作开发的项目,没有统一的代码规范,那么最终的编写状态必定风格迥异,产生的结果:对内,阅读审核代码是很痛苦的;对外,公司形象就是差。
单干的项目也必须要严格按照代码规范,因为最终还是会对内和对外。
要改变一个误解的常识,代码规范并不影响代码质量,代码质量的维度可从运行稳定、执行性能、易维护性三方面考虑。
解决方法
将代码规范控制在源头:格式化工具 Astyle -- 易维护性
阶段性检查代码质量:静态检查工具 Cppcheck -- 运行稳定
最终的质量保证手段:业务流程化和审核专业化 -- 执行性能
人是最容易犯错的,减少犯错就得借助三化:工具化、流程化、专业化。
方案论证
格式化工具:
Astyle
官网:http://astyle.sourceforge.net/
功能介绍:
A Free, Fast, and Small Automatic Formatter for C, C++, C++/CLI, Objective‑C, C#, and Java Source Code.
许可:开源且商用免费
源码:https://sourceforge.net/p/astyle/code/HEAD/tree/
优劣:功能强大、易用、免费,支持以IDE插件方式使用,如MDK、IAR、SourceInsignt、VS-Code、Notepad等,但不支持代码风格检查
Cpplint
官网:https://google.github.io/styleguide/cppguide.html
功能介绍:
Cpplint is a command-line tool to check C/C++ files for style issues following Google's C++ style guide. Cpplint is developed and maintained by Google Inc. at google/styleguide, also see the wikipedia entry
许可:开源且商用免费
源码:https://github.com/cpplint/cpplint
优劣:功能强大,遵从Google C++代码规范的强烈建议使用,支持以IDE插件方式使用,但自有代码规范需要修改源码,难度较大
静态检查工具:
静态检查工具罗列:https://github.com/analysis-tools-dev/static-analysis
部分介绍
Cppcheck
官网:http://cppcheck.net/
功能介绍:
Cppcheck is a static analysis tool for C/C++ code. It provides unique code analysis to detect bugs and focuses on detecting undefined behaviour and dangerous coding constructs.
The goal is to have very few false positives. Cppcheck is designed to be able to analyze your C/C++ code even if it has non-standard syntax (common in embedded projects).
许可:开源且商用免费
源码:https://github.com/danmar/cppcheck
优劣:功能强大、免费、易用,支持 windows、linux
SonarQube
官网:https://www.sonarqube.org/
功能介绍:
许可:社区版和收费版,C/C++收费版才有
源码:社区版
优劣:功能强大,但用于C/C++需要付费
推荐文章(工具对比):《C++静态检测工具有哪些值得推荐?》
简要如下图,详细参见上述链接
静态检查项:
工具对比:
推荐文章(工具对比):《九大顶级静态代码分析工具 - 知乎 (zhihu.com)》
推荐文章(工具对比):《C++静态代码扫描哪家强?》
简要如下图,详细参见上述链接
从易用性和免费角度出发的最终方案选择:
Astyle 可在源头有效控制编码风格且免费易用,故选择Astyle作为编码风格工具
Cppcheck 功能强大,支持单文件和目录方式检查,可与Jenkins集成,检查规则全面且检查出的问题都是编译正常的且免费易用
接受收费的情况下,建议选择 SonarQube,功能很强大,支持语言丰富,检查规则全面,易于集成且支持多阶段检查,出问题时技术支持也更迅速
实施过程
AStyle推荐文章:
《在IAR中利用AStyle插件格式化代码》:https://blog.csdn.net/qq_20222919/article/details/103857352
《STM32开发中Keil使用Astyle自动格式化整理代码》:https://blog.csdn.net/yuleitao/article/details/103408567
《如何在notepad++实现代码自动化排版(调用Astyle)》:https://www.cnblogs.com/libra13179/p/9120360.html
《vscode添加 Artistic Style(AStyle)》:https://blog.csdn.net/tianma666666/article/details/103478792
《Source Insight 4.0集成格式化工具AStyle》:https://blog.csdn.net/redeagle_gbf/article/details/81566871
详细使用方法见官方手册:http://astyle.sourceforge.net/astyle.html
Cppcheck检查演示
数组越界赋值:
类模板递归次数太多潜在问题:
详细使用方法见Cppcheck官方手册:https://cppcheck.sourceforge.io/manual.html
总结建议
规范的代码可提升团队开发效率;
规范的代码可减少编写引入的bug;
规范的代码可降低维护的成本;
规范的代码可使代码审查更容易;
规范的代码可帮助自身和公司成长;
工具、流程只是为了将犯错减少但并不能实现零错误,所以为了将犯错降至更低只能以专业化的态度认真对待代码规范这个事,只有对代码质量报以敬畏之心,代码才会有质量可言,切不可迷之自信!
建议业务流程:
1、代码编写/修改,实现业务功能
2、Astyle格式化,满足公司或团队的代码风格,也是为了后期维护
3、Cppcheck静态检查,将隐含错误遏制在开发阶段
4、开发本地功能验证,主要是验证功能逻辑的准确性,这一步是必须要做的,是代码质量的第一道关卡,无法用工具替代
5、Jenkins构建版本,且生成Cppcheck检查报告,与步骤3相互印证,检查上库代码是否与仓代码冲突,是否有语法错误,有问题回到步骤1
6、Gerrit代码审核(专业团队),任何工具都无法检测逻辑正确性,所以审核者要对编码规范、语法错误、功能逻辑要认真审核,有问题回到步骤1,这是代码质量的关键环节
7、构建版本开发验证,有问题回到步骤1,无问题即可Merge到代码仓
8、构建版本测试验证,Jira提单跟踪反馈至开发,这一步是对外发布的最后一道关卡,必须严格按照测试用例进行验证,同步骤5一样是代码质量的关键环节
9、测试用例满足,即可对外发布
【C/C++】 代码质量控制手段的更多相关文章
- 提高代码质量 CheckStyle FindBugs PMD
提高代码质量-工具篇 注:这是一篇翻译文章,原文:How to improve quality and syntax of your Android code,为了理解连贯,翻译过程中我修改了一些陈述 ...
- 重读 code complete 说说代码质量
重读code complete 说说代码质量 2014年的第一篇文章本来计划写些过去一年的总结和新年展望,但是因为还有一些事情要过一阵才能完成,所以姑且不谈这个,说说最近重读code complete ...
- 使用JSLint提高JS代码质量
随着富 Web 前端应用的出现,开发人员不得不重新审视并重视 JavaScript 语言的能力和使用,抛弃过去那种只靠“复制 / 粘贴”常用脚本完成简单前端任务的模式.JavaScript 语言本身是 ...
- JSLint JavaScript代码质量审查工具汉化中文版隆重发布
JSLint是一款JavaScript代码质量审查工具,它可以指出代码中错误.不规范的地方,非常之严格,甚至多写一个空格都会发出警告. JSLint的审查规则,根据众多前辈多年编程经验而写,字字珠玑, ...
- sonar的安装与代码质量检测实例
说明:sonar依赖数据库. mysql优化 1.笔者使用的是mysql数据库.首先对mysql做简单的优化配置. [root@localhost bin]# cat /etc/my.cnf [mys ...
- 提高 Android 代码质量的4个工具
在这篇文章中,我将通过不同的自动化工具如CheckStyle,FindBugs,PMD以及Android Lint来介绍(如何)提高你的安卓代码质量.通过自动化的方式检查你的代码非常有用,尤其当你在一 ...
- [git]安装git-pylint-commit-hook提高python项目中的代码质量
什么是'git-pylint-commit-hook' 我在工作中,团队为了保证代码和提高代码的质量,要求每个项目都要求安装git-pylint-commit-hook,它是个钩子,会在你提交代码到本 ...
- 提高Objective-C代码质量心机一:简化写法
提高OC代码质量的小心机 一.OC特性 OC 为 C 语言添加了面向对象特性,是其超集; OC 使用动态绑定的消息结构,也就是,在运行时才会检查对象类型; 接收一条消息后,究竟应执行何种代码,由运行期 ...
- ESLint 检查代码质量
利用 ESLint 检查代码质量 其实很早的时候就想尝试 ESLint 了,但是很多次都是玩了一下就觉得这东西巨复杂,一执行检查就是满屏的error,简直是不堪入目,遂放弃.直到某天终于下定决心深入看 ...
- 程序员的恶性循环:加班->没空学习->老是写同等水平代码->无法提升代码质量->老是出BUG->老是需要修改->加班->...
程序员的恶性循环:加班->没空学习->老是写同等水平代码->无法提升代码质量->老是出BUG->老是需要修改->加班->...
随机推荐
- 推荐一款功能齐全的开源MES/万界星空科技mes
推荐一款功能齐全的开源MES 万界星空科技商业开源MES可以提供包括制造数据管理.计划排程管理.生产调度管理.库存管理.质量管理.人力资源管理.工作中心/设备管理.工具工装管理.采购管理.成本管理.项 ...
- 从零玩转设计模式之工厂方法设计模式-gonchangfangfamoshi
title: 从零玩转设计模式之工厂方法设计模式 date: 2022-12-08 13:22:13.669 updated: 2022-12-11 23:03:22.379 url: https:/ ...
- 【scikit-learn基础】--『监督学习』之 决策树回归
决策树算法是一种既可以用于分类,也可以用于回归的算法. 决策树回归是通过对输入特征的不断划分来建立一棵决策树,每一步划分都基于当前数据集的最优划分特征.它的目标是最小化总体误差或最大化预测精度,其构建 ...
- RV1126 DSI 调试
一.基本信息 开发板:RV1126 linux版本:4.19.111 显示屏:HX070JGI50(7寸) 显示器分别率:1024 * 600 二.MIPI协议 连接示意图(图片来源,正点资料) MI ...
- Java 如何在PPT中设置形状组合、取消组合、编辑组合形状
PPT中支持插入多达9种不同类型的形状,每种类型下又包含数十种形状样式.针对如此多种类型的形状,为页面元素设计需要.方便形状操作管理的目的,可通过形状"组合"的方式来固定多个形状的 ...
- 看这里!带你快速体验MindSpore V1.0(For ubuntu 18.04)
摘要: 本文介绍了如何在Ubuntu 18.04上安装CPU版本的MindSpore V1.0.并使用安装好的MindSpore进行了LeNet的模型训练. Part One:引言 在HC2020大会 ...
- web内容如何保护:如何有效地保护 HTML5 格式的视频内容?
文章资料还没有整理完,现在还不通顺,但是可以做笔记看 HTML是用于创建web页面和web应用程序的公开标准的标记语言.HTML文件基本上是纯文本文件,这意味着软件应用程序和普通人可以轻松地创建.读取 ...
- APP 备案公钥、签名 MD5、SHA-1、SHA-256获取方法。
公钥和 MD5 值可以通过苹果开发工具.Keytool.appuploder 等多种工具获取,最简单的就是以 appuploader为例. 1.下载 appuploader工具 ,点击此处 下载 ...
- IOS上架流程详解,包含审核避坑指南!
准备 开发者账号 完工的项目 上架步骤 一.创建App ID 二.创建证书请求文件 (CSR文件) 三.创建发布证书 (CER) 四.创建Provisioning Profiles配置文件 (PP ...
- IAST 初探:博采众长、精准定位、DevOps友好
之前的文章中,我们了解了 SAST 和 DAST,本文将介绍将两者优势相结合的安全测试技术--IAST. ✦ ✦ 交互式应用安全测试(IAST)是一个自动识别和诊断应用程序和 API 漏洞的技术,它结 ...