如何正确编写C++头文件

在C++中，头文件（.h或.hpp）用于声明函数、类和模板等代码实体

1. 包含保护：为了防止头文件被多次包含，应使用预处理器指令#pragma once或者#ifndef/#define/#endif结构。

// 使用 #pragma once
#pragma once

// 或者使用 #ifndef / #define / #endif
#ifndef MY_HEADER_H
#define MY_HEADER_H

// 头文件内容

#endif // MY_HEADER_H

2. 使用命名空间：为了避免命名冲突，可以将代码放入命名空间中。

namespace MyNamespace {
    // 类、函数、变量等声明
}

3. 声明而非定义：头文件中应该只包含声明，不应该包含定义。对于函数和类的成员函数，可以在头文件中声明，并在相应的源文件中定义。对于模板类或函数，由于它们需要在编译时生成代码，因此它们的定义通常需要放在头文件中。

// 声明一个函数
void myFunction();

// 声明一个类
class MyClass {
public:
    void myMemberFunction();
};

4. 包含必要的头文件：如果你的头文件依赖于其他头文件中的声明，请确保包含这些头文件。这有助于确保使用你的头文件的其他代码能够正确编译。

#include<iostream>
#include<vector>
#include "OtherHeader.h"

5. 使用前向声明：当类或函数仅通过指针或引用使用时，可以使用前向声明而不是包含整个头文件。这有助于减少编译依赖关系和编译时间。

// 前向声明一个类
class AnotherClass;

// 使用指针或引用的函数声明
void someFunction(AnotherClass* ptr);
void anotherFunction(const AnotherClass& ref);

6. 注释：为了提高代码的可读性和可维护性，请确保为头文件中的所有声明添加适当的注释。

遵循这些建议，你将能够编写出更加健壮、易于维护的C++头文件。