c – 我可以在函数头中包含cppcheck抑制吗？

2023年2月2日 348次阅读

我添加了一个内联注释来抑制函数的cppcheck unusedFunction警告,但我想在函数头中包含它,以便Doxygen可以记录所有未使用的函数(我正在实现一个API,所以我有很多函数,不会在我的来源中使用).我宁愿不压缩所有unusedFunction错误,而是基于每个函数.

我想做这样的事情：

/**
 * API function description
 * 
 * @param p1 function pointer to the ...
 * @return 0 if successful, -1 otherwise.
 * // cppcheck-suppress unusedFunction
 */
int CreateTask(Task_FuncPtr p1)
{    
    return doSomething();
}

但是当我这样做时,cppcheck没有“看到”内联抑制.如果我将它移到标题之外,但在函数声明之前,那么抑制就可以了. cppcheck documentation似乎意味着抑制需要直接在生成然后错误的行之前.

有没有成功呢？

最佳答案 看一下cppcheck源码(文件
preprocessor.cpp函数RemoveComments()),看来你做不到.

识别评论的代码是：

if (str.compare(i, 2, "//") == 0) { /* ... */ }

和

else if (str.compare(i, 2, "/*") == 0) { /* ... */ }

找到注释后,管理警告抑制的代码为：

if (_settings && _settings->_inlineSuppressions) {
    std::istringstream iss(comment);
    std::string word;
    iss >> word;
    if (word == "cppcheck-suppress") {
        iss >> word;
        if (iss)
            suppressionIDs.push_back(word);
    }
}

所以cppcheck会跳过空格并在//或/ *之后立即检查第一个标记.

不幸的是,Doxygen的特殊注释块以/ **,///,/ *开头！要么 //！第三个字符阻止“正确匹配”.

更改：

if (word == "cppcheck-suppress") { /* ... */ }

成：

if (contains(word, "cppcheck-suppress")) { /* ... */ }
// or if (ends_with(word, "cppcheck-suppress"))

应该允许你想要的东西：

/**
 * API function description
 *
 * @param p1 function pointer to the ...
 * @return 0 if successful, -1 otherwise.
 */
/** cppcheck-suppress unusedFunction */

要么

/// API function description
///
/// @param p1 function pointer to the ...
/// @return 0 if successful, -1 otherwise.
///
/// cppcheck-suppress unusedFunction

你可以在http://trac.cppcheck.net/开一张票

点赞