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

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

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

或者，您也可以尝试

//! 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。