如何记录可选参数

【问题标题】：How can I document optional parameters如何记录可选参数
【发布时间】：2015-07-01 12:19:38
【问题描述】：

我的函数具有不同的参数列表，具体取决于是否通过#define 常量SMBSUS_INH 启用设备功能

例如

#ifndef SMBUS_INH
    handle initHandle(foo_t foo, SMB_Info_t smbInfo, bar_t bar);
#else
    handle initHandle(foo_t foo, bar_t bar);
#endif

我怎样才能正确记录这一点？

如果我在每个 #if...else 子句中编写两次文档，doxygen 会忽略不相关的吗？还是它仍然会看到两个文档块并抱怨一个没有相关功能？

有没有更好的方法来管理这个？谢谢。

【问题讨论】：

【解决方案1】：

Doxygen 会进行部分预处理：如果您将特定文档放在 if/else 部分，则只会显示相关文档。然而，这真的是一件好事吗？作为用户，我可能有兴趣查看每个不同的原型，即使在编译时禁用。

【讨论】：

谢谢！这个想法是用户将阅读文档，其中还记录了#define 开关。例如，我可以保留参数并让用户在不使用时将它们设置为 NULL，但未使用的代码仍然需要空间，这是在嵌入式平台上，因此空间至关重要。使用开关意味着代码仅在该功能可用时才在设备上。
虽然我想我可以在函数内部使用开关并注释掉相关的代码部分......