C++头文件组织策略

C++头文件组织策略

头文件组织是C++项目管理的重要方面。良好的头文件组织可以减少编译时间、避免循环依赖并提高代码可维护性。

包含保护防止头文件被重复包含。

#ifndef MYCLASS_H
#define MYCLASS_H

#include

class MyClass {
std::string name_;
public:
explicit MyClass(const std::string& name);
void display() const;
};

#endif

#pragma once是包含保护的现代替代方案。

#pragma once

#include

class DataProcessor {
std::vector data_;
public:
void process();
int get_result() const;
};

前向声明减少头文件依赖。

class Engine;
class Transmission;

class Car {
Engine* engine_;
Transmission* transmission_;
public:
Car();
~Car();
void start();
};

头文件应该只包含必要的声明，实现放在源文件中。

#pragma once

class Calculator {
public:
int add(int a, int b);
int multiply(int a, int b);
private:
int last_result_;
};

内联函数可以在头文件中定义。

#pragma once

class Point {
int x_, y_;
public:
Point(int x, int y) : x_(x), y_(y) {}

int x() const { return x_; }
int y() const { return y_; }

void set_x(int x) { x_ = x; }
void set_y(int y) { y_ = y; }
};

模板定义必须在头文件中。

#pragma once

template
class Container {
T* data_;
size_t size_;
public:
explicit Container(size_t size) : data_(new T[size]), size_(size) {}
~Container() { delete[] data_; }

T& operator[](size_t index) { return data_[index]; }
const T& operator[](size_t index) const { return data_[index]; }

size_t size() const { return size_; }
};

头文件包含顺序应该遵循一致的规则。

#include "myclass.h"

#include
#include
#include

#include "other_project_header.h"

命名空间可以组织头文件中的声明。

#pragma once

namespace myproject {
namespace utils {

class StringHelper {
public:
static std::string trim(const std::string& str);
static std::string to_upper(const std::string& str);
};

}
}

良好的头文件组织是大型C++项目成功的关键因素。