如何在文档中显示常量变量或宏

Question

是否可以在doxygen文档中使用常量变量或宏的值？

我在源文件中有以下行

#define RD_IDN 0x01
#define RD_TEMP 0x02
// etc

我想在文档中的其他地方使用这些值，如下所示：

/* If the received command code is 0x01, the device will return it's unique ID. */

Answer 1

我认为不可能这样做。 doxygen的内置C预处理器的功能在documentation中有描述，并且在注释中没有关于宏的替换。

作为替代方案，您可以尝试类似的东西

//! Your RD_IDN description
#define RD_IDN 0x01
#define RD_TEMP 0x02

然后

/*! If the received command code is #RD_IDN, the device will return it's unique ID. */

Doxygen将添加一个指向宏的链接，当你悬停鼠标时，Your RD_IDN description会显示广告提示。要查看值，您仍然需要单击它。请注意，必须在您的Doxyfile上将ENABLE_PREPROCESSING设置为默认值YES。