SKIP_LINTING

在 3.27 版本中新增。

此属性允许您将特定源文件排除在 linting(代码检查)过程之外。linting 过程包括针对源文件运行工具,例如 <LANG>_CPPLINT<LANG>_CLANG_TIDY<LANG>_CPPCHECK<LANG>_ICSTAT<LANG>_INCLUDE_WHAT_YOU_USE,以及将头文件作为 VERIFY_INTERFACE_HEADER_SETS 的一部分进行编译。通过在源文件上设置 SKIP_LINTING,上述 linting 工具将不会为该特定文件执行。

示例

考虑一个包含多个源文件的 C++ 项目,例如 main.cppthings.cppgeneratedBindings.cpp。在此示例中,您希望将 generatedBindings.cpp 文件排除在 linting 过程之外。为了实现此目的,您可以使用 SKIP_LINTING 属性和 set_source_files_properties() 命令,如下所示:

add_executable(MyApp main.cpp things.cpp generatedBindings.cpp)

set_source_files_properties(generatedBindings.cpp PROPERTIES
    SKIP_LINTING ON
)

在提供的代码片段中,为 generatedBindings.cpp 源文件设置了 SKIP_LINTING 属性为 true。因此,当执行由 <LANG>_CPPLINT<LANG>_CLANG_TIDY<LANG>_CPPCHECK<LANG>_ICSTAT<LANG>_INCLUDE_WHAT_YOU_USE 指定的 linting 工具执行时,它们将跳过分析 generatedBindings.cpp 文件。

通过使用 SKIP_LINTING 属性,您可以有选择地排除特定源文件不参与 linting 过程。这使您可以将 linting 工具的焦点集中在项目的相关部分,从而提高 linting 工作流程的效率和有效性。