头文件的标准写法

1.头文件保护（Include Guards）

使用#ifndef、#define和#endif防止头文件被多次包含。

2.包含必要的标准库头文件

按需包含标准库头文件（如、等）。

3.前向声明（Forward Declarations）

尽量使用前向声明减少依赖。

4.命名空间

将相关类/函数放入命名空间以避免命名冲突。

5.注释

添加必要的注释说明头文件的功能。

示例1：基础头文件

// my_class.h
#ifndef MY_CLASS_H  // 头文件保护，名称通常为大写+下划线，与文件名一致
#define MY_CLASS_H
 
#include <string>  // 包含必要的标准库头文件
 
// 前向声明（如果需要）
class AnotherClass;
 
// 命名空间
namespace my_project {
 
	// 类声明
	class MyClass {
	public:
	    // 构造函数
	    explicit MyClass(int value);
	 
	    // 成员函数
	    void printValue() const;
	    void setValue(int value);
	    int getValue() const;
	 
	    // 静态成员函数
	    static int getInstanceCount();
	 
	private:
	    int value_;
	    static int instance_count_;  // 静态成员变量
	};
 
} // namespace my_project
 
#endif // MY_CLASS_H

示例2：包含模板和内联函数的头文件

// math_utils.h
#ifndef MATH_UTILS_H
#define MATH_UTILS_H
 
#include <cmath>  // 包含数学库
 
namespace math_utils {
 
	// 模板函数（直接在头文件中实现）
	template <typename T>
	T clamp(T value, T min, T max) {
	    if (value < min) return min;
	    if (value > max) return max;
	    return value;
	}
	 
	// 内联函数
	inline double toRadians(double degrees) {
	    return degrees * M_PI / 180.0;
	}
 
} // namespace math_utils
 
#endif // MATH_UTILS_H

示例3：C++11风格的枚举类头文件

// color.h
#ifndef COLOR_H
#define COLOR_H
 
namespace graphics {
 
	// 枚举类（强类型枚举）
	enum class Color {
	    RED,
	    GREEN,
	    BLUE,
	    ALPHA
	};
	 
	// 函数声明
	void printColor(Color color);
 
} // namespace graphics
 
#endif // COLOR_H

关键点说明

头文件保护
	宏名称通常与文件名一致（如MY_CLASS_H对应my_class.h）。
	避免使用_开头的宏名（可能与系统宏冲突）。
	
前向声明
	如果头文件只需声明类的存在（而非完整定义），使用前向声明减少编译依赖。
	
命名空间
	将类/函数放入命名空间，避免全局作用域的命名冲突。
	
	模板和内联函数
		模板和内联函数通常直接在头文件中实现，因为编译器需要看到完整定义。
注释
添加注释说明头文件的用途或作者信息（可选）。

配套的源文件（.cpp）示例

// my_class.cpp
#include "my_class.h"  // 包含对应的头文件
 
namespace my_project {
 
	// 静态成员变量初始化
	int MyClass::instance_count_ = 0;
	 
	// 构造函数
	MyClass::MyClass(int value) : value_(value) {
	    instance_count_++;
	}
	 
	// 成员函数实现
	void MyClass::printValue() const {
	    std::cout << "Value: " << value_ << std::endl;
	}
	 
	void MyClass::setValue(int value) {
	    value_ = value;
	}
	 
	int MyClass::getValue() const {
	    return value_;
	}
	 
	int MyClass::getInstanceCount() {
	    return instance_count_;
	}
 
} // namespace my_project

通过遵循这些规则，可以确保头文件的正确性和可维护性，同时减少编译错误和命名冲突的风险。