C++ включает конвенции заголовка

На самом деле это не имеет большого значения [по крайней мере, если у вас нет гигантского проекта], но я, вероятно, склоняюсь к его включению.

Я бы предложил включить заголовок include для Y в X.cc, даже если это кажется излишним. Это дает вам преимущество быть очень явным в отношении ваших зависимостей.

В качестве сопутствующего замечания, вы всегда должны #include сопутствующий заголовок для файла cpp в качестве первого #include'd файла. (Первым включаемым файлом в X.cpp должен быть X.h) Это гарантирует, что заголовок включает соответствующие файлы для разрешения своих собственных зависимостей, иначе вы можете непреднамеренно полагаться на порядок включения в вашем исходном файле.

Я не уверен, почему это было бы хорошей практикой.

С другой стороны, не включение ненужных файлов в X.h - это то, что я считаю очень хорошей практикой.

Например, в следующем сценарии:

X.h

#include "Y.h"

class X
{
private:
    Y * m_pY;

public:
    X();
    ~X();
}

Достаточно переслать объявление Y . Клиенты класса X не должны нести расходы на включение файла заголовка для Y :

Xh

class Y; // include Y.h in X.cc instead

class X
{
private:
    Y * m_pY;

public:
    X();
    ~X();
}

Это возможно в файле заголовка, поскольку объявление класса X не требует конкретных сведений о Y (например, размер экземпляра); только то, что Y - это класс. Кроме того, клиенты класса X никогда не работают с типом Y , поскольку он не является частью открытого интерфейса X .

Для больших проектов отказ от ненужных директив include в файлах заголовков может значительно сократить время сборки.

Это также может избежать загрязнения пространства имен пользователей вашего класса символами из ваших частных классов / классов реализации.

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

В вашем примере я бы включил Xh в X.cc только для уменьшения количества включений. Да, в более общем случае, когда у вас есть A.cc, включая Xh, и в качестве побочного эффекта возможность ссылаться на материал в Yh, когда вы можете удалить Xh, вам придется вручную добавить Yh, потому что вы не добавляли его раньше . По крайней мере, компилятор будет по вашему делу и напоминать вам.

В случае он вам нужен, когда он вам нужен, будь то в файле заголовка или в модуле.

Операторы #include в файлах заголовков могут увеличить время компиляции. Для игрушечных приложений или больших систем с одной зависимостью, как вы описываете, это не будет проблемой. Но по мере роста вашего приложения время компиляции будет увеличиваться. Одно из решений MSVC - использовать предварительно скомпилированные заголовки (которые приносят собственный набор проблем) или исключить все операторы #include в заголовках. Последний - мой подход по умолчанию, и я сначала пытаюсь использовать форвардные объявления там, где это необходимо:

yh:

class Y {public: int foo_; };

xh:

class Y;
class X { public: Y* y_; };

main.cc:

#include "y.h"
#include "x.h"

int main()
{
  X x;
  return 0;
}

Если использование форвардных объявлений невозможно, просто помните, что #include не делает ничего, кроме переноса содержимого указанного файла в эту точку, и это можно сделать так же легко из файла cc, как и из заголовка:

yh:

class Y {public: int foo_; };

xh:

class X {public: Y y_; }; // note this declaration requires a concrete type for Y

main.cc:

#include "y.h"
#include "x.h"

int main()
{
  X x;
  return 0;
}