文档互斥定义

Question

我正在用 C 编写一个小程序，我想记录它以便其他人可以更改一些细节。我用#defines 写了一个config.h 文件，它可以启用或不启用某些操作，其中一些是互斥的，有些则不是。

不互斥的例子：

#define USE_A
#define USE_B
#define USE_C

互斥示例：

#define BUILD_FULL
#define BUILD_COMPACT

到目前为止，我通过记录我不想使用的功能来选择要编译的程序的配置，例如：

//#define BUILD_FULL
#define BUILD_COMPACT

构建 COMPACT 可执行文件。

如何为注释掉的功能编写文档？

我试过了：

#define USE_A //!< Special Feature
#define USE_B //!< Special Feature
//#define USE_C //!< Special Feature

我在没有USE_C 的情况下编译了它，但显然我丢失了文档，因为 doxygen 没有解析它。如果我误解了使用定义的正确方法，您将如何重写 #define 流程？

Answer 1

您可以测试宏的值，而不仅仅是它的存在。例如，使用 0 禁用选项，或使用 1 启用它。然后，使用#if 而不是#ifdef 来测试条件。

#define USE_A 1    //!< Special Feature
#define USE_B 1    //!< Special Feature
#define USE_C 0    //!< Special Feature

#if USE_A
...
#elif USE_C
...
#endif