Существуют ли правила подключения include-файлов в С++?

Question

[sitev_ru]

Написал проект, в котором используется много файлов, в каждом по несколько классов и они ссылаются друг на друга. И вот в какой-то момент возникла неразрешимая ошибка с которой не так просто сразу разобраться. Используется класс, который как бы не описан (хотя, конечно же, он описан)...

Может существует какие-то правила, используя которые не возникнет таких ошибок?

Как сделал я. Я описал один h-файл, в него сложил остальные h-файлы и подключаю этот главный h-файл только в cpp-файлах. Раньше вроде как прокатывал такой подход). Здесь исходник: https://github.com/sitev/cms

Answer 1

[15432]

Я в проектах делаю так:

• в шапке .h файла #pragma once
  
• в .h файле только описание класса - члены, методы, иногда структуры
  
• инклюдим в .h другие .h только если этого требует описание класса
  
• всё остальное необходимое для реализации инклюдим в .cpp
  

Comments

[sitev_ru]

Расширил свой вопрос, что Вы думаете по этому поводу?

[nirvimel]

Это хорошо работает для проектов со множеством *.cpp, в которых определяется все то, что объявлено в заголовках.
Но при разработке headers-only библиотеки, когда в проекте всего один *.cpp, в который подключаются тесты, в которые подключается все исходники на *.hpp, такой подход с выносом определений в *.cpp уже не прокатит.

[15432]

sitev_ru: я думаю, что в такой структуре легко запутаться, что где требуется и что куда подключено :)

Answer 2

[Mercury13]

Незыблемых правил два.
1. В CPP первым — свой хедер. Это даёт уверенность, что в хедере нет недостающих включений.
2. Избегать циклической зависимости по интерфейсам. Делить программу на слои и не включать ничего из верхних слоёв.

Если уж второе не получилось — есть три решения, каждое из которых решает свою задачу.
1. Forward declaration, полумера против сильной связанности классов.

// Хедер 1
class Master;

class Slave {
  Master* master;
}

// Хедер 2
class Master {
  Slave slave;
}

2. Разорвать порочный круг интерфейсом.

// Хедер 1
class Master {  // interface
public:
  virtual void enumSlaves(const EnumSlavesCallback& v) = 0;
  virtual ~Master() = default; 
}

class Slave {
  Master* master;
}

// Хедер 2
class MyMaster :  public Master {
public:
  Slave slave;
  void enumSlaves(const EnumSlavesCallback& v) override {}
}

3. Вынести общие типы/функции в отдельный хедер под названием someDefines.h или someUtils.h.

Answer 3

[Алексей Гордиенко]

почитайте впро предкомпилированные заголовки
https://en.wikipedia.org/wiki/Precompiled_header