最近在尝试做代码审查，发现很多时候我们把时间花在了低级的规范性错误上面，为了节省这一部分的时间，我尝试了各种静态检查工具，这里做个简单的汇总，方便日后的查看。

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如下：

#include <iostream>

int main(int argc, char *argv[])
{
    std::string message = "Hello World";
    std::cout << message << std::endl;
    return 0;
}

使用cpplint hello.cpp我们会得到如下消息：

hello.cpp:0: No copyright message found. You should have a line: “Copyright [year] “ [legal/copyright] [5] hello.cpp:4: { should almost always be at the end of the previous line [whitespace/braces] [4] Done processing hello.cpp Total errors found: 2

过滤掉我们不要求的项

如果你并不是严格的直接Google C++ Style Guide，cpplint可能会报一些你不想要的错误，这个时候，我们可以通过filter参数过滤掉这些错误，比如假如你们不执行关于copyright的规定，你可以加上如下filter。

1	cpplint --filter=-legal/copyright hello.cpp

legal/copyright这个字段可以在错误列表中找到，注意前面的-号，表示不做这个检查，相反的+表示做这个检查。

另外一种方式是在你想要忽略的代码后面加上// NOLINT

1
2
3

int main(int argc, char* argv[])
{ // NOLINT
}

集成到 VIM 中

每次都需要执行这个命令会显得非常的繁琐，把这个过程自动化的一个方式是集成到你的开发环境中去，在编辑的时候自动执行这条命令。比如我给我的VIM安装了ale插件，同时配置cpplint为检查工具。具体的配置方法，请查看ale的官方文档。

在代码 commit 之前自动检查

当然如果你的开发环境不支持这种集成，你可以把这个过程放到git的pre-commit或者pre-push之前，下面是来自brickgao的一段gist

#!/bin/sh
#
# Modified from http://qiita.com/janus_wel/items/cfc6914d6b7b8bf185b6
#
# An example hook script to verify what is about to be committed.
# Called by "git commit" with no arguments.  The hook should
# exit with non-zero status after issuing an appropriate message if
# it wants to stop the commit.
#
# To enable this hook, rename this file to "pre-commit".

if git rev-parse --verify HEAD >/dev/null 2>&1
then
    against=HEAD
else
    # Initial commit: diff against an empty tree object
    against=4b825dc642cb6eb9a060e54bf8d69288fbee4904
fi

# Redirect output to stderr.
exec 1>&2

cpplint=cpplint
sum=0
filters='-build/include_order,-build/namespaces,-legal/copyright,-runtime/references'

# for cpp
for file in $(git diff-index --name-status $against -- | grep -E '\.[ch](pp)?$' | awk '{print $2}'); do
    $cpplint --filter=$filters $file
    sum=$(expr ${sum} + $?)
done

if [ ${sum} -eq 0 ]; then
    exit 0
else
    exit 1
fi

cppcheck

cppcheck是一个历史比较悠久的静态检查工具，它的侧重点在于检查代码的逻辑而不是代码的风格。它可以和cpplint一起使用，相互补充。

安装

绝大部分的系统，可以直接通过包管理器安装cppcheck，以Ubuntu为例：

1	sudo apt install cppcheck

使用

1	cppcheck src

表示检查src路径下面的所有文件

配置

和cpplint一样，这个工具支持过滤，你可以通过--enable=all打开所有的过滤器

1	cppcheck --enable=all src

具体支持的filter，可以通过cppcheck --help中的--enable选项说明来查看，这不再赘述。

不足

这个工具最大的问题在于比较容易误判，所以我通常很少会直接使用--enable=all，而是直接使用默认的配置。

clang-check、clang static analyzer、clang-tidy

把这三个工具放一块儿讲是因为它们实际上都是clang衍生出来的工具，极其类似互有交叉，大部分情况下我们使用其中之一就够了（我实际上不清楚为什么会有三个这样的工具同时存在）。

这几个工具实际上是编译器级别的检查，它们需要编译文件从而检查代码，所以理论上他们的可靠性会比cpplint和cppcheck要强一些，同时它的耗时也会它们长一些。

目前我使用的是clang-tidy，它和clang-check非常类似，但是它支持扩展自定义的检查。另外官方提供run-clang-tidy脚本用于实现对整个项目的文件做检查，用起来非常的方便。

安装

在Ubuntu中使用如下命令可以安装clang-tidy

1	sudo apt install clang-tidy

使用

clang-tidy的使用，比前面提到的工具要复杂一些，因为它需要编译源码，所以需要知道怎么编译源文件。我们可以通过CMake来生成这个编译命名文件：

1	cmake -DCMAKE_EXPORT_COMPILE_COMMANDS=ON ...

DCMAKE_EXPORT_COMPILE_COMMANDS这个选项会生成一个叫compile_commands.json的文件，有了这个文件，我们可以直接在编译目录下执行run-clang-tidy命令，对整个项目做静态的检查。

配置

clang-tidy支持的检查项特别多，你可以通过：

1	clang-tidy -list-checks -checks=*

来查看所有支持的检查，使用：

1	clang-tidy -list-checks

来查看所有已经enable的检查，具体的文档请参考clang-tidy

注意：如果你使用的是zsh，上面的通配符会失效，你可以切换到bash执行这些命令，或者使用setopt no_nomatch来关闭zsh对于通配符的拦截