【发布时间】: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