很多语言有自己的编码规范,比如google C++编码规范、阿里的java编码规范等等,但是只有编码规范无法解决开发人员提交的代码是否符合约定的编码规范,更无法自动化review已提交的代码服务器上的代码质量,鉴于上面的问题,网上搜罗了一些C++编码规范审计小工具,为后面团队自动化CI/CD的源代码规范审计之用。
clang-format
严格来说,它不是静态检查工具,而是代码格式化的工具,类似的工具还有astyle
,但是相对来说,clang-format
会好用一些,支持的配置参数也多一些。它的使用请参考Clang-Format Style Options。
使用统一的代码格式化工具,可以极大的代码格式上面的问题,在多人合作的项目中显得特别的有用。
cpplint
cpplint是Google
提供的工具,用于检查我们的代码是否符合Google C++ Style Guide,我们目前的编码规范是基于Google
的规范,所以这个工具基本上可以直接使用。
安装
这个工具是Python写的,所以你可以直接通过pip来安装这个工具的最新版本
1 |
pip3 install cpplint |
使用
这个工具的使用比较简单,直接使用命令:
1 2 |
cpplint <文件名> cpplint --recursive <目录名> |
比如我们有源文件hello.cpp
如下:
1 2 3 4 5 6 |