如何警告函数声明和函数定义中参数名称的差异

C++ How to warning about difference between argument names in function declaration and definition

本文关键字:函数 参数 定义 何警告 警告 声明      更新时间:2023-10-16

是否有一种方法可以获得关于函数声明与其定义之间参数名称不匹配的警告?

声明

double divide(int a, int b);

定义

double divide(int b, int a)
{
    return a / b;
}

对于使用函数divide的用户,期望结果是a/b,而不是b/a。

我知道,编译器不能这样做,但是有一些静态分析工具可以这样做吗?如果有,是哪些?

你可以使用clang-tidy。称它为编译器有点夸张,但也许有一个选项可以让clang发出clang-tidy警告。您想要的特定选项是readability-inconsistent-declaration-parameter-name

编译器不关心你声明中的参数名称,你甚至可以写void foo(int, int);,所以没有不匹配,也没有这样的警告。如果由于某种原因发现这种不匹配令人困惑,只需在声明中省略参数名称。

您只是对检查现有代码感兴趣,还是想确保代码避免此问题并愿意重新设计接口?

后一种情况:

如果你有许多相同类型的参数,那么不一致可能是一个问题(我看到过比你的例子更糟糕的):

void foo(bool fast, bool small, bool trivial);
foo(true, false, false);

你所要求的是一种确保foo的声明和定义是一致的方法——但是你忽略了调用和声明之间的不一致性。

另一种解决方案是用setRoutines创建一个参数结构体。比如:

struct FooArg {
   bool fast, small, trivial;
   FooArg &setFast(bool fast_) {fast=fast_;return *this;}; 
   ...
};
void foo(FooArg const&);
foo(FooArg().setFast(true).setSmall(false)...);

这样就避免了声明、定义和调用之间的不一致,但必须更加冗长。