替代 C++ 中的条件编译，使用多个 .cpp 文件

Question

假设我有一个使用条件编译的 C++ 类：

C.hpp

namespace NS{
  class C {
    public:
      C(void);
      ~C(void);
      int func( int arg1 );
    private:
      int memberVar;
}

C.cpp:

#include "C.hpp"

namespace NS{
  C::C( void ){ memberVar = 0; }
  C::~C( void ) {}
  int C::func( int arg1 ){
    int retval = 0;
    memberVar = arg1;
#ifdef DEV_BUILD
    retval = memberVar;
    printf( "memberVar was set.\n" );
#endif
    return retval;
  }
}

（这是一个简化的示例；假设类C 有几百行长，其中一些函数使用条件编译，每个函数都使用相同的条件：#ifdef DEV_BUILD。该应用程序是一个嵌入式系统应用程序, 条件是用来区分测试硬件和生产硬件, 有一些区别)

有人建议我改为在单独的 .cpp 文件中实现 funcs……但我有点不知道最好的方法是什么。

我的第一个冲动是创建 C_dev.cpp 和 C_prod.cpp，以不同的方式实现 C::func()，然后编辑 C.cpp：

#include "C.hpp"
#ifdef DEV_BUILD
#include "C_dev.cpp"
#else
#include "C_prod.cpp"
#endif

namespace NS{
  C::C( void ){ memberVar = 0; }
  C::~C( void ) {}
}

...但这是不好的风格吗？还是有其他问题？

附加限制：

• 不能使用子类。
• 无法使用模板类。

（更新：建议使用单独的文件，但不是必需的。我愿意接受其他建议）

Answer 1

要点 1：如果您在一大堆相同的代码中散布着数百个小改动，请使用条件编译。它通常更容易阅读和维护。

但是，如果您在功能级别上有差异，您可以将不同的功能拆分到不同的实现文件中。通常我用操作系统包装器来做这件事，比如说，在 Linux 和 Windows 上获取目录列表的差异是相当粗粒度的。 （注：此示例已被 C++17 废弃）

要点 2：不要制作多个标题。这只会使问题更加复杂。您希望在两个实现之间公开一个公共接口。如果你做不到，你已经迷路了，需要另寻出路。制作一个适合所有实现的通用标头。

对于这个答案，所有实现都使用 Asker 的原始标头 C.hpp：

namespace NS{
  class C {
    public:
      C(void);
      ~C(void);
      int func( int arg1 );
    private:
      int memberVar;
}

我将 Asker 的示例分成三个 cpp 文件：一个具有跨所有构建的通用功能，两个实现包含差异的功能。这样您就不会重复任何您绝对不需要重复的功能。

C_common.cpp 所有共享功能都在这里

#include "C.hpp"

namespace NS{
  C::C( void ){ memberVar = 0; }
  C::~C( void ) {}
}

C_debug.cpp：带有调试语句的函数放在这里

#include "C.hpp"

namespace NS{
  int C::func( int arg1 ){
    int retval = 0;
    memberVar = arg1;
    retval = memberVar;
    printf( "memberVar was set.\n" );
    return retval;
  }
}

C_no_debug.cpp：没有调试语句的函数放在这里

#include "C.hpp"

namespace NS{
  int C::func( int arg1 ){
    memberVar = arg1;
    return memberVar;
  }
}

链接程序时，总是链接 C_common 并指定链接 C_debug 和 C_no_debug 中的哪一个。

您有时可以通过分解复杂函数并仅隔离差异并为差异提供从共享函数中调用的函数来更进一步。

C_common.cpp

#include "C.hpp"

namespace NS{
  C::C( void ){ memberVar = 0; }
  C::~C( void ) {}
  int C::func( int arg1 ){
    memberVar = arg1;
    debugstuff(); // calls the different functionality
    return memberVar;
  }
}

C_debug.cpp：

#include "C.hpp"

namespace NS{
    void debugstuff()
    {
        printf( "memberVar was set.\n" );
    }
}

C_no_debug.cpp：

#include "C.hpp"

namespace NS{
    void debugstuff()
    {
    }
}

这往往难以扩展，因为您可能会使用许多单行函数。请参阅上面的大点数 1。但是，如果差异恰到好处，您可以利用传递函数参数来减少垃圾邮件。在这种情况下，合乎逻辑的做法是传入调试字符串。一个打印，另一个丢弃。

C_common.cpp

#include "C.hpp"

namespace NS{
  C::C( void ){ memberVar = 0; }
  C::~C( void ) {}
  int C::func( int arg1 ){
    memberVar = arg1;
    debugstuff("memberVar was set.\n"); // calls the different functionality
                                        // and tells it what to do!
    return memberVar;
  }
}

C_debug.cpp：

#include "C.hpp"

namespace NS{
    void debugstuff(const char * message)
    {
        printf( message );
    }
}

C_no_debug.cpp：

#include "C.hpp"

namespace NS{
    void debugstuff(const char * )
    {
    }
}

Answer 2

如果没有更多信息，我建议告诉您使用不同文件的人正在将您引向扭曲的方向。

让我来谈谈具体问题：...but is this bad style? Or otherwise problematic?

是的，是的。

• 这与其他人所做的相反，暗示您做错了。此外，任何新开发人员都必须了解您系统的独特“构建怪癖”。
• 这意味着您有两倍的文件供构建系统/软件存储库跟踪。
• 您发现的任何错误都必须在两个文件中修复（这就是我所说的保持文件同步的意思）。
• 您可能需要一种方法来了解用于构建 exe 的源代码版本。