Куда с точки зрения структурированности нужно писать #include в .h файлы, или в .cpp?

Question

[Hatemylifezxc]

Допустим есть Header.h файл и соответствующий ему Header.cpp файл с определениями.
Я раньше думал, что наиболее структурированным удобным и понятным код получается если в хедере инклюдить только файлы проекта которые пишуется в ковычках #inlcude "", а в cpp файле единственный инклюд с такими ковычками это соответствющий ему хедер файл с объявлениями. Так человек который читает код может не заглядывая в код реализации, посмотреть Хедер и понять взаимосвязи.
В cpp же файл нужно включать только файлы библиотек #include <>, так при написании реализации если например понадобится std::map вверху файла сразу написать нужный инклюд, плюс в некоторых средах это делается автоматически достаточно написать std::map.
НО допустим в хедере объявляются функции с типами, которые определяются в библиотеке ? Что тогда делать ?
Все равно приходится подключать библиотеки в хедер файле.
Или например бывает удобно показать реализацию некоторых небольших функций прям в хедере.
Получается никак не избавиться от запутанности и инклюды библиотек будут как в хедер так и в cpp файле ?
нужно ли дублировать в таком случае инклюды ?

Comments

[Евгений Шатунов]

Hatemylifezxc , информация к сведению.
Твой вопрос довольно сильно пересекается с этим вопросом. Насколько сильно, что, можно сказать, повторяет его.

Answer 1

[Армянское Радио]

Главное, чему нужно следовать при размещении инклюдов - принцип наибольшей закрытости - в *.h файл должно торчать как можно меньше сущностей.

Например, за размещение в *.h файле матюка типа using namespace std; разместившему грозит неприятный разнос на code review c вердиктом УБРАТЬ ДОЛОЙ

Потому что такое размещение приводит к глобальному загаживанию пространства имен с жуткими последствиями.

Таким образом, чем меньше разного рода инклюдов напихано в хидер - тем лучше. Это позволяет несколько ускорить компиляцию, так как компилятору придется меньше парсить, а также сокращает заваливание глобального пространства имен декларациями.

Например, если у вас в классе есть указатель на какой-то другой класс, не нужно тащить инклюд этого класса, достаточно сделать forward declaration.

"Понимать взаимосвязи" позволяет IDE. Там можно прекрасно посмотреть, что куда включено.

Comments

[Hatemylifezxc]

как если не секрет IDE позволяет ? Насколько знаю только студия Enterprise позволяет построить карту кода.
В других ИДЕ вообще подобного нет

[Антон Жилин]

Hatemylifezxc, в CLion и ReSharper тоже есть такая фича

[Hatemylifezxc]

Антон Жилин, специально гуглил, ничего подобного этому https://docs.microsoft.com/ru-ru/visualstudio/mode...
не находил, ни в clion ни в resharper

[Антон Жилин]

Hatemylifezxc, в ReSharper: Extensions > ReSharper > Inspect > Analyze Includes in Solution