在多个文件之间共享枚举的正确方法是什么?

What's the proper way to share an enum across multiple files?

本文关键字:方法 是什么 枚举 文件 之间 共享      更新时间:2023-10-16

我想在我当前(C++)项目的客户端和服务器部分使用相同的枚举,但不确定正确的方法。我可以很容易地将枚举写在它自己的文件中,并将其包含在两个文件中,但这感觉是一种糟糕的做法。把它放在一个命名空间中,然后把它同时包含在两者中,这是正确的方法吗?

我知道这有点主观,如果有更好的地方可以回答"最佳实践"问题,请告诉我。

编辑(详细说明):我将数据从客户端发送到服务器,在这种情况下,我想告诉客户端状态的变化。但是,我希望避免每次更改状态时都发送组成状态的所有信息,而是只发送一个引用数组中索引的数字。因此,我认为最好的方法是使用枚举,但我需要在客户端和服务器上使用相同的枚举,以便它们都能理解数字。希望这是有道理的。

将其放在头文件中似乎是合理的,将其封装在命名空间中也很有用。我发现自己在做一些关于enums的事情是

whatevsenum.hpp的内容:

namespace whatevs
{
    enum Enum
    {
        FOO = 0,
        BAR,
        BLARGH,
        MEH,
        SIZE
    };
} // namespace whatevs

然后每当我需要在其他地方的头文件/源文件中使用它时:

#include "whatevsenum.hpp"
void do_something_with(whatevs::Enum value)
{
    // do stuff
}
...
do_something_with(whatevs::FOO);

tl;dr:将它放在头文件(*.h)中,#include是需要使用枚举的头文件。

注意:这也适用于新的(C++11)枚举类

不需要使用命名空间。在大多数情况下,在多个位置包含头文件(而不是.cpp文件)是常见的,也是必要的。作为一般规则,头文件应仅包括函数/方法声明和类型定义(这包括类定义、结构定义,当然还有enum定义)。模板函数和方法还需要在头文件中定义(而不仅仅是声明)。

关于头文件需要记住的另一件事是,您应该始终使用include保护来避免多个定义。

这个常见问题解答可能会有所帮助,但如果您需要更完整地介绍C++,则可能还不够

声明:

void foo(int bar); //Goes in a header file
class argle;

定义:

// Put this in a .cpp file
int foo(int bar) {
    return bar - 42;
};
// Put this in a header file
template<type T>
int baz(T t) {
    return 42;
}
// Put this in a header file
struct bargle {
    int fizz;
    char *whizz;
}

编辑:

发现了这个,它应该有助于你理解在哪个文件中放什么。事实上,对于C++学习者来说,这整本维基书看起来是一个很好的资源:http://en.wikibooks.org/wiki/C%2B%2B_Programming