clang-tidy:将一些检查列入黑名单(或使用regex进行检查)

基础概念

clang-tidy 是一个用于静态代码分析的工具，它可以帮助开发者发现代码中的潜在问题，并提供修复建议。通过配置，可以将某些检查列入黑名单，或者使用正则表达式（regex）来进行特定的检查。

相关优势

1. 灵活性：可以根据项目需求定制检查规则，避免不必要的警告和错误。
2. 提高代码质量：通过静态代码分析，可以在编译前发现潜在的问题，减少运行时错误。
3. 节省时间：自动化的代码检查减少了手动代码审查的工作量。

类型

1. 黑名单检查：将某些检查规则列入黑名单，使其在代码分析时被忽略。
2. 正则表达式检查：使用正则表达式来匹配特定的代码模式，并进行相应的检查。

应用场景

1. 忽略特定警告：在某些情况下，某些警告可能并不适用于当前项目，可以通过黑名单来忽略这些警告。
2. 自定义检查：对于特定的代码模式，可以使用正则表达式来进行自定义的检查。

如何将检查列入黑名单

假设我们有一个项目，其中某些函数调用会产生不必要的警告，我们可以通过以下步骤将这些警告列入黑名单：

1. 创建配置文件：创建一个 clang-tidy 配置文件，例如 clang-tidy.toml。

Checks = [
    "-*,cppcoreguidelines-*"
]

在这个例子中，-*,cppcoreguidelines-* 表示忽略所有 cppcoreguidelines 类别的检查。

1. 运行 clang-tidy：使用配置文件运行 clang-tidy。

clang-tidy -config-file=clang-tidy.toml source_file.cpp

使用正则表达式进行检查

假设我们希望检查所有函数调用，其中函数名包含 FIXME，可以使用以下步骤：

1. 创建配置文件：创建一个 clang-tidy 配置文件，例如 clang-tidy.toml。

Checks = [
    "regex-checks"
]

[[regex-checks]]
name = "FIXME in function calls"
regex = "\\bFIXME\\b.*\\b\\w+\\s*\\("

在这个例子中，regex-checks 是一个自定义的检查类型，name 是检查的名称，regex 是用于匹配的正则表达式。

1. 运行 clang-tidy：使用配置文件运行 clang-tidy。

clang-tidy -config-file=clang-tidy.toml source_file.cpp

参考链接

• Clang-Tidy Documentation

通过以上步骤，你可以灵活地配置 clang-tidy，以满足项目的特定需求，并提高代码质量。