C / C ++ включають порядок файлів заголовка

Який порядок повинен містити вказані файли, тобто які причини включення одного заголовка до іншого?

Наприклад, чи йдуть системні файли, STL та Boost до або після того, як локальні включають файли?

Я не думаю, що є рекомендоване замовлення, поки воно складається. Що дратує, коли одні заголовки вимагають, щоб перші заголовки були включені першими ... Це проблема з самими заголовками, а не з порядком включень.

Мої особисті переваги - перейти від локального до глобального, кожен підрозділ в алфавітному порядку, тобто:

1. h файл, відповідний цьому файлу cpp (якщо застосовується)
2. заголовки з того ж компонента,
3. заголовки з інших компонентів,
4. системні заголовки.

Моє обґрунтування 1. полягає в тому, що він повинен довести, що кожен заголовок (для якого є cpp) може бути #included без передумов (terminus technicus: заголовок "автономний"). А решта просто схоже логічно витікає звідти.

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

Зокрема, про це згадує "Думаючи про C ++", посилаючись на "Великий масштаб C ++ Software Design" Лакоса:

Приховані помилки використання можна уникнути, переконавшись, що .h файл компонента сам розбирає - без наданих зовні декларацій чи визначень ... У тому числі .h файл як перший рядок файлу .c забезпечує відсутність критичного фрагмента Інформація, властива фізичному інтерфейсу компонента, відсутня у файлі .h (або, якщо є, ви дізнаєтесь про нього, як тільки спробуєте зібрати файл .c).

Тобто, включіть у такому порядку:

1. Прототип / заголовок інтерфейсу для цієї реалізації (тобто файл .h / .hh, що відповідає цьому файлу .cpp / .cc).
2. Інші заголовки цього ж проекту, за потребою.
3. Заголовки інших нестандартних, несистемних бібліотек (наприклад, Qt, Eigen тощо).
4. Заголовки інших "майже стандартних" бібліотек (наприклад, Boost)
5. Стандартні заголовки C ++ (наприклад, iostream, funkcionalні тощо)
6. Стандартні заголовки C (наприклад, cstdint, dirent.h тощо)

Якщо будь-який із заголовків має проблеми з включенням до цього наказу, виправте їх (якщо ваш) або не використовуйте їх. Бойкот бібліотек, які не пишуть чисті заголовки.

Посібник зі стилів Google C ++ стверджує майже зворотне, насправді зовсім не виправдання; Я особисто схильний до підходу Лакоса.

Я дотримуюся двох простих правил, які уникають переважної більшості проблем:

1. Усі заголовки (і справді будь-які вихідні файли) повинні містити те, що їм потрібно. Вони не повинні покладатися на своїх користувачів, включаючи речі.
2. Як доповнення, всі заголовки повинні містити захисні пристрої, щоб вони не потрапляли кілька разів шляхом надмірного амбіційного застосування правила 1 вище.

Я також дотримуюся вказівок:

1. Спочатку включіть заголовки системи (stdio.h тощо) з роздільною лінією.
2. Згрупуйте їх логічно.

Іншими словами:

#include <stdio.h>
#include <string.h>

#include "btree.h"
#include "collect_hash.h"
#include "collect_arraylist.h"
#include "globals.h"

Хоча, будучи настановами, це суб’єктивна річ. Правила з іншого боку, я суворо виконую, навіть до того, щоб забезпечити "загорткові" файли заголовків з включенням охоронців і згрупованих включає, якщо якийсь недобрий сторонній розробник не підписався на моє бачення :-)

Щоб додати до стіни власну цеглу.

1. Кожен заголовок повинен бути самодостатнім, що можна перевірити, лише якщо він включений спочатку хоча б один раз
2. Не слід помилково змінювати значення стороннього заголовка, вводячи символи (макрос, типи тощо)

Тому я зазвичай так:

// myproject/src/example.cpp
#include "myproject/example.h"

#include <algorithm>
#include <set>
#include <vector>

#include <3rdparty/foo.h>
#include <3rdparty/bar.h>

#include "myproject/another.h"
#include "myproject/specific/bla.h"

#include "detail/impl.h"

Кожна група відокремлена порожнім рядком від наступної:

• Перший заголовок, відповідний цьому файлу cpp (перевірка обґрунтованості)
• Системні заголовки
• Сторонні заголовки, організовані за наказом залежності
• Заголовки проектів
• Проекти приватних заголовків

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

Я рекомендую:

1. Заголовок модуля .cc, який ви будуєте. (Допомагає гарантувати, що кожен заголовок у вашому проекті не має неявних залежностей від інших заголовків у вашому проекті.)
2. C системні файли.
3. Системні файли C ++.
4. Платформа / ОС / інші файли заголовків (наприклад, win32, gtk, openGL).
5. Інші файли заголовків вашого проекту.

І звичайно, в алфавітному порядку в кожному розділі, де це можливо.

Завжди використовуйте прямі декларації, щоб уникнути зайвих #includes у файлах заголовка.

Я майже впевнений, що це не рекомендована практика в будь-якому місці розумного світу, але мені подобається, що система рядків включає в себе довжину імені файлів, відсортовану за лексикою в межах однієї довжини. Так:

#include <set>
#include <vector>
#include <algorithm>
#include <functional>

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

Це не суб'єктивно. Переконайтеся, що ваші заголовки не покладаються на те, щоб бути #included у визначеному порядку. Ви можете бути впевнені, що це не має значення, до якого порядку ви додаєте заголовки STL або Boost.

По- перше , включають заголовок , відповідний .cpp ... Іншими словами, source1.cppповинна включати в себе , source1.hперш ніж включати що - небудь ще. Єдиний виняток, про який я можу подумати - це використання MSVC з попередньо складеними заголовками, і в цьому випадку ви змушені включати stdafx.hраніше всього іншого.

Обґрунтування: Включення source1.hдо будь-яких інших файлів гарантує, що він може стояти самостійно без залежностей. Якщо source1.hпізніше набуде залежність, компілятор негайно попередить вас додати необхідні форвардні декларації до source1.h. Це в свою чергу гарантує, що заголовки можуть бути включені в будь-який порядок залежними від них.

Приклад:

джерело1.h

class Class1 {
    Class2 c2;    // a dependency which has not been forward declared
};

source1.cpp

#include "source1.h"    // now compiler will alert you saying that Class2 is undefined
                    // so you can forward declare Class2 within source1.h
...

Користувачі MSVC: Настійно рекомендую використовувати попередньо складені заголовки. Отже, перемістіть усі #includeдирективи для стандартних заголовків (та інших заголовків, які ніколи не зміняться) на stdafx.h.

Включіть від найбільш конкретного до найменш конкретного, починаючи з відповідного .hpp для .cpp, якщо такий існує. Таким чином, будуть виявлені будь-які приховані залежності у файлах заголовків, які не є самодостатніми.

Це ускладнюється використанням попередньо складених заголовків. Одним із способів цього є, не роблячи конкретного компілятора проекту, використовувати один із заголовків проекту в якості файлу заздалегідь складеного заголовка.

Це важке запитання у світі C / C ++, у якому стільки елементів перевищує стандарт.

Я думаю, що порядок заголовка файлів не є серйозною проблемою, доки він збирається, як це сказав.

Мої ідеї такі: якщо в усіх цих заголовках немає конфлікту символів, будь-який порядок є нормальним, і питання залежності заголовка можна виправити пізніше, додавши #include рядки до несправного .h.

Справжній клопот виникає, коли якийсь заголовок змінює свою дію (перевіряючи #if умови) відповідно до того, які заголовки вище.

Наприклад, у stddef.h у VS2005 є:

#ifdef  _WIN64
#define offsetof(s,m)   (size_t)( (ptrdiff_t)&(((s *)0)->m) )
#else
#define offsetof(s,m)   (size_t)&(((s *)0)->m)
#endif

Тепер проблема: Якщо у мене є власний заголовок ("custom.h"), який потрібно використовувати з багатьма компіляторами, включаючи деякі старіші, які не містять offsetofу своїх заголовках системи, я повинен написати у своєму заголовку:

#ifndef offsetof
#define offsetof(s,m)   (size_t)&(((s *)0)->m)
#endif

І не забудьте повідомити користувачеві #include "custom.h" після всіх заголовків системи, інакше рядок offsetofв stddef.h стверджує про помилку перегляду макросу.

Ми молимось не зустрічати більше таких випадків у своїй кар’єрі.