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

时间:2011-05-26 02:26:38

标签: c++

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

我知道这有点主观,如果有更好的“最佳实践”问题,请指导我。

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

2 个答案:

答案 0 :(得分:11)

将它放在头文件中似乎是合理的,将它包装在命名空间中也很有用。我发现自己在枚举中做的事情是

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);

答案 1 :(得分:8)

<强> TL; DR: 将它放在头文件(* .h)和#include头文件中,无论你需要使用枚举。

注意:这也适用于新的(C ++ 11)enum classes

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

关于头文件要记住的另一件事是你应该总是使用include guard来避免多个定义。

This FAQ可能有所帮助,但如果您需要更完整的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;
}

编辑:

找到this,它可以帮助您了解放入哪个文件的内容。事实上,整个wikibook看起来像是C ++学习者的一个很好的资源:http://en.wikibooks.org/wiki/C%2B%2B_Programming