【问题标题】:Should I include unused parameters for consistency?我应该包含未使用的参数以保持一致性吗?
【发布时间】:2014-08-12 01:21:25
【问题描述】:

这个问题可以抽象为其他编程语言,它更像是一个礼仪/风格问题。因此,我期待答案中的一些意见。但在回复中,我想看看为什么一种方法比另一种更干净的理由。

我有一个有点大的模块。它是专有串行通信协议的解析器。在这个模块中,我有 40-50 个类似的功能。他们都采取了类似的论点。当我收到一个有效的数据包并删除它的所有帧时,我将根据数据包的功能代码调用这些函数之一。

所以,为了论证,这里是一个声明:

/*!
 * \brief Processes an incoming foo packet and updates the bar data structure
 * \param     data_len Length of the packet's data payload
 * \param[in] p_data   Pointer to the packet's data payload
 */
static bool_t process_foo_response(uint8_t data_len, uint8_t * p_data);

现在,对于某些数据包,我从没想过会收到任何数据负载。数据长度始终为 0,并且不会检查任何有效负载。我对 data_len 或 p_data 参数没有任何用途或用途。我将这些参数包含在每个函数的参数列表中只是为了保持一致性,以便所有函数都具有相同的通用接口。但这是否具有误导性 - 最好根本没有那些未使用的参数?我很难决定这是否是最干净和最直接的做事方式,或者我是否会在几年内迷惑下一个程序员。

当我有一个已使用的参数时,我通常会像这样在参数列表文档中调用它

/*!
* \param     data_len This packet has no payload, a payload length of 0 is verified.
* \param[in] p_data   This packet has no payload, so no payload will be processed by
                      this function.
*/

我最初想要保留上游逻辑的所有参数的一个原因 - 我正在考虑创建一个函数指针列表,其中包含基于函数代码的各种偏移量。这样,它就不需要是带有指向参数列表的指针的二维数组。但是我的上游逻辑现在只是一个效率低下的大开关/案例(也许有一天我可以证明花时间让它更漂亮、更高效)但是,这种方法非常简单,而且实施起来很快!

【问题讨论】:

  • 我认为,拥有通用类型的函数指针是拥有未使用参数的有力论据。另一个可能是,您可以想象一个现在没有有效负载的函数将来可能有一个(可选地)。无论哪种情况,我都建议在这些函数中明确检查data_len == 0
  • 我通常总是检查以确保长度为 0,但我没有 100% 的时间这样做。所以我有一些 \todo 列表项要返回并添加对一些功能的检查。
  • 考虑static bool_t process_foo_response0(void) { return process_foo_response(0, NULL); },而不是使用未使用参数的通用代码调用。

标签: c


【解决方案1】:

在严格的 C 语言中,虽然您可以在函数声明中省略参数名称,但您必须在函数定义中具有参数名称。与 C++ 不同,在 C++ 中,参数名称​​可以在定义中省略。

处理未使用的函数参数的一种常见做法(因为许多编译器会警告未使用的参数)是将参数转换为void,通常通过宏:

#define UNUSED_PARAMETER(p) ((void)(p))

这会使“未使用的参数”警告静音,但不会产生任何额外的代码。


至于是否在声明中省略名称,我认为这是一种权衡。保持声明中的名称与定义保持一致,但从声明中删除它们有助于强制执行它们未被使用的事实。

【讨论】:

  • 在这种情况下,将其重命名为 used_pa​​ram 可能会更好,以进一步阻止某人错误地假设该函数使用该参数执行某些操作。
【解决方案2】:

额外参数困扰我的一点是有额外的错误空间:当没有参数时,用户无法使用错误的参数调用函数,但使用忽略的参数,用户可以传递缓冲区长度为非零,期望发生某些事情,但您的代码仍会忽略它。

您可以做的一件事是在您的函数中使用断言,期望有效负载为空,而不是盲目地假设有效负载为零。

您可以在此基础上做的另一件事是提供该函数的两个独立版本。一个不带参数,用于手动使用,一个带参数,用于保持一致性。

【讨论】:

  • 让我编辑我的 OP。我不是盲目地假设有效载荷长度为 0 - 我检查了一下。但我没有验证有效负载指针是否为 NULL,也许这将是一个改进。
  • 我同意你的观点。这里更大的危险是假设某些东西在起作用,而实际上它不是。如果有人错误地使用函数,最可取的事情就是抛出编译器错误。但如果我不能这样做,那么下一个最好的办法就是抛出一个运行时错误,该错误会在测试的早期被捕获。
  • 是的,这和我想的完全一样。如果你包含适当的断言,唯一的大缺点是错误检查被移到运行时,程序员可能需要做一些额外的输入。它在灵活性+一致性方面对程序员的不便做了一个小小的权衡,如果你真的想要,你可以随时提供两个版本的函数。
猜你喜欢
  • 1970-01-01
  • 2014-09-03
  • 2015-10-08
  • 1970-01-01
  • 2017-02-16
  • 1970-01-01
  • 2010-09-08
  • 1970-01-01
  • 1970-01-01
相关资源
最近更新 更多