如何在一个地方注释 #ifdef 下的值
how to comment values under #ifdef in one place
假设我们有一个 C++ 项目应该在多个平台上运行(例如,arm/arm64),我们需要为每个平台提供特定于目标的值。
现在我们这样做:
#ifdef PLATFORM_ARM
#define TIMEOUT_VALUE 0
#define OUR_MAGIC_VALUE 1
#elif PLATFORM_ARM64
#define TIMEOUT_VALUE 2
#define OUR_MAGIC_VALUE 3
#endif
我可以在哪里为每个定义的名称添加注释,以便可以从每个定义访问它?
注意:我无法像
那样在自己的 #ifdef 中定义每个值
// a comment for TIMEOUT_VALUE
#ifdef PLATFORM_ARM
#define TIMEOUT_VALUE 0
#elif PLATFORM_ARM64
#define TIMEOUT_VALUE 2
#endif
// a comment for OUR_MAGIC_VALUE
#ifdef PLATFORM_ARM
#define OUR_MAGIC_VALUE 1
#elif PLATFORM_ARM64
#define OUR_MAGIC_VALUE 2
#endif
因为我有这些值的列表和树。
谢谢。
编辑 1:
例如,我们有 6 个目标,其中 4 个支持一个 FEATURE,
所以我们写:
#if defined(ARM)
#define FEATURE 1
#elif defined(ARM64)
#define FEATURE 0
#elif define(MIPS)
#define FEATURE 1
etc... for other platforms.
然后我有代码在某处读取这个定义:
#if FEATURE
do something. Note that this part can't be described in a target specific file, because it can have the same implementation for several targets.
#endif
现在我想有一个地方来概括描述此功能的含义和作用。
您可以定义一个代理宏并为最终用户使用的宏写一条注释:
#ifdef PLATFORM_ARM
#define TIMEOUT_VALUE_IMPL 0
#define OUR_MAGIC_VALUE_IMPL 1
#elif PLATFORM_ARM64
#define TIMEOUT_VALUE_IMPL 2
#define OUR_MAGIC_VALUE_IMPL 3
#endif
// a comment for TIMEOUT_VALUE
#define TIMEOUT_VALUE TIMEOUT_VALUE_IMPL
// a comment for OUR_MAGIC_VALUE
#define OUR_MAGIC_VALUE OUR_MAGIC_VALUE_IMPL
您也可以考虑使用常量代替宏。
假设我们有一个 C++ 项目应该在多个平台上运行(例如,arm/arm64),我们需要为每个平台提供特定于目标的值。
现在我们这样做:
#ifdef PLATFORM_ARM
#define TIMEOUT_VALUE 0
#define OUR_MAGIC_VALUE 1
#elif PLATFORM_ARM64
#define TIMEOUT_VALUE 2
#define OUR_MAGIC_VALUE 3
#endif
我可以在哪里为每个定义的名称添加注释,以便可以从每个定义访问它?
注意:我无法像
那样在自己的 #ifdef 中定义每个值// a comment for TIMEOUT_VALUE
#ifdef PLATFORM_ARM
#define TIMEOUT_VALUE 0
#elif PLATFORM_ARM64
#define TIMEOUT_VALUE 2
#endif
// a comment for OUR_MAGIC_VALUE
#ifdef PLATFORM_ARM
#define OUR_MAGIC_VALUE 1
#elif PLATFORM_ARM64
#define OUR_MAGIC_VALUE 2
#endif
因为我有这些值的列表和树。
谢谢。
编辑 1: 例如,我们有 6 个目标,其中 4 个支持一个 FEATURE, 所以我们写:
#if defined(ARM)
#define FEATURE 1
#elif defined(ARM64)
#define FEATURE 0
#elif define(MIPS)
#define FEATURE 1
etc... for other platforms.
然后我有代码在某处读取这个定义:
#if FEATURE
do something. Note that this part can't be described in a target specific file, because it can have the same implementation for several targets.
#endif
现在我想有一个地方来概括描述此功能的含义和作用。
您可以定义一个代理宏并为最终用户使用的宏写一条注释:
#ifdef PLATFORM_ARM
#define TIMEOUT_VALUE_IMPL 0
#define OUR_MAGIC_VALUE_IMPL 1
#elif PLATFORM_ARM64
#define TIMEOUT_VALUE_IMPL 2
#define OUR_MAGIC_VALUE_IMPL 3
#endif
// a comment for TIMEOUT_VALUE
#define TIMEOUT_VALUE TIMEOUT_VALUE_IMPL
// a comment for OUR_MAGIC_VALUE
#define OUR_MAGIC_VALUE OUR_MAGIC_VALUE_IMPL
您也可以考虑使用常量代替宏。