SKIP_LINTING

於 3.27 版本新增。

此屬性允許您將特定的原始碼檔案排除在程式碼檢查(linting)程序之外。程式碼檢查程序包括在原始碼檔案上執行 <LANG>_CPPLINT<LANG>_CLANG_TIDY<LANG>_CPPCHECK<LANG>_INCLUDE_WHAT_YOU_USE 等工具,以及編譯標頭檔作為 VERIFY_INTERFACE_HEADER_SETS 的一部分。藉由在原始碼檔案上設定 SKIP_LINTING,上述的程式碼檢查工具將不會針對該特定檔案執行。

範例

考量一個包含多個原始碼檔案的 C++ 專案,例如 main.cppthings.cppgeneratedBindings.cpp。在此範例中,您想要將 generatedBindings.cpp 檔案排除在程式碼檢查程序之外。為了達成此目的,您可以使用 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>_INCLUDE_WHAT_YOU_USE 所指定的程式碼檢查工具時,它們將會跳過分析 generatedBindings.cpp 檔案。

藉由使用 SKIP_LINTING 屬性,您可以選擇性地將特定的原始碼檔案排除在程式碼檢查程序之外。這能讓您將程式碼檢查工具的焦點放在專案的相關部分,進而提升程式碼檢查工作流程的效率和有效性。