.clang-tidy文件是Clang-Tidy的配置文件,它可以用来配置Clang-Tidy的检查规则和参数。以下是.clang-tidy文件的编写规则:
- 文件名必须为.clang-tidy。
- 文件必须位于项目的根目录或者编译目录下。
- 文件采用YAML/JSON格式编写
- 每个YAML条目包含以下几个关键字:
- Checks:指定要启用的检查规则,可以是单个检查器或者多个检查器的组合。
- WarningsAsErrors:将指定的警告视为错误。
- HeaderFilterRegex:指定要检查的头文件的正则表达式。
- IncludePaths:指定头文件的搜索路径。
- User:指定自定义检查器的路径。
- CheckOptions:指定检查器的参数。【更加细粒度的控制】
生效说明
clang-tidy优先运行 命令行中的命令,例如:命令行中设置了–use-color,那么就会覆盖.clang-format中UseColor
具体编写规则
*
表示所有-
表示去掉
Checks: '-*,modernize-*'
HeaderFilterRegex: '.*'
CheckOptions:
- key: modernize-use-auto
value: 1
- key: modernize-raw-string-literal.UseBackslashes
value: false
...