Как правильно организовать код большого проекта на C++?

@DevAlone · Регистрация: 02.08.2016

Студворк — интернет-сервис помощи студентам

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

Хотелось бы услышать мнения на счёт того, как вы организуете код своих проектов(желательно C++). Речь не только про раскладывание кода по директориям и названия переменных, но и про архитектуру в общем.

Я, например, вижу для себя следующий вариант.

Кратко про код стайл(в принципе можете не читать, их тыщи, этот просто нравится мне):

Кликните здесь для просмотра всего текста

Имена классов с большой буквы в CamelCase, например

C++
1
class EventHandler;

.
Названия объектов аналогично, но первая буква маленькая, например

C++
1
Image backgroundImage;

.
Названия примитивных типов(int, char, double, etc) маленькими через нижнее подчёркивание, например

C++
1
double percent_of_fails;

Названия методов с мальнькой в camelCase и отражают действие функции, например

C++
1
void addModule(std::shared_ptr<Module> module);

Структура файлов:
Пример:

Python
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
engine/
|
|-engine.i
|-core.h
|-core.cpp
|-math/
  |
  |-math.i
  |-vector3d.h
  |-vector3d.cpp
|-scene/
  |-
  |-scene.i
  |-scene.h
  |-scene.cpp
  |-object.h
  |-object.cpp

*.h файлы содержат традиционный костыль в виде

C++
1
#ifndef FILE_H

, ну или

C++
1
#pragma once

. Первым идёт инклуд C++ хедеров, затем сторонние библиотеки типа буста, затем *.i файл из данной директории и после всё остальное. Сущности в каждой директории имеют своё одноимённое пространство имён, т.е.

C++
1
engine::Core

,

C++
1
engine::math::Vector3D

и т.д.
*.i файлы содержат:
1 forward declarations(чтоб не замусоривать ими файлы остальные файлы)
2 инклуды всех *.h файлов из данной директории. Спорный пункт, т.к. при небольших изменениях кода нужно будет много перекомпилировать, но зато очень удобно подключать нужный пакет(если говорить в терминах современных ЯП) инклудом *.i файла.

В идеале это всё нужно автоматизировать и скрыть за синтаксическим сахаром вроде
@import engine
@from engine::math import *

Покритикуйте мой вариант. Также буду рад почитать примеры организации кода в ваших проектах. Спасибо.

@hoggy · 05.06.2017, 21:39

Сообщение от DevAlone

Покритикуйте мой вариант.

Сообщение от DevAlone

*.i файлы

неузнаваемо.
выглядит дико.

Сообщение от DevAlone

Image backgroundImage;

Сообщение от DevAlone

double percent_of_fails;

имена переменный в разных стилях.

Сообщение от DevAlone

void addModule(std::shared_ptr<Module> module);

Сообщение от DevAlone

Image backgroundImage;

имена функций в такое же стиле, как и имя переменной.

Сообщение от DevAlone

В идеале это всё нужно автоматизировать и скрыть за синтаксическим сахаром вроде
@import engine
@from engine::math import *

WTF?

Сообщение от DevAlone

Речь не только про раскладывание кода по директориям и названия переменных, но и про архитектуру в общем.

не бывает "архитектур в общем"
бывают конкретные архитектуры под конкретные задачи.

Сообщение от DevAlone

Также буду рад почитать примеры организации кода в ваших проектах

обычно есть каталог include,
который содержит все публичные хедера всех целей сборки
ну и кучка каталогов,
каждый из которых - отдельная цель сборки.

хотя лично мне больше нравится модель:

Code
1
2
3
4
5
6
7
8
9
10
name_lib
 |--- resource.txt
 |--- settings.txt
 |--- include
 |      `-- name_lib
 |            `-- *.h (публичные)
 |--- src
 |     |--- *.h (приватные)
 |      `-- *.cpp
  `-- doc

resource.txt содержит скрипт для развертывания ресурсов,
которые необходимы цели сборки для работы.

settings.txt содержит список зависимостей цели сборки.
ну и может быть какие то уникальные настройки.

@DevAlone · 05.06.2017, 22:43 **[ТС]**

Сообщение от hoggy

неузнаваемо.
выглядит дико.

Ну можно _file.h, сути не меняет.

Сообщение от hoggy

имена переменный в разных стилях.

Потому что одни объекты, другие - "простые типы", впрочем, может это и вправду лишнее)

Сообщение от hoggy

имена функций в такое же стиле, как и имя переменной.

А в чём проблема?

Сообщение от hoggy

WTF?

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

C++
1
2
3
4
5
6
7
8
9
10
@import engine
@from engine::math import *
@from engine::scene import Object
 
int main() 
{
    engine::Core core;
    Vector3D v;
    Object o;
}

В такой:

C++
1
2
3
4
5
6
7
8
9
10
11
#include <engine/engine.i>
#include <engine/math/math.i>
using namespace engine::math;
#include <engine/scene/scene.i>
 
int main()
{
    engine::Core core;
    Vector3D v;
    engine::scene::Object o;
}

@hoggy · 05.06.2017, 23:24

Сообщение от DevAlone

Ну можно _file.h, сути не меняет.

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

классическим подходом здесь является:

C++
1
2
3
4
5
6
7
8
// библиотека может состоять из множества хедеров
// имя файла совпадающее с именем библиотеки
// подключает всю библиотеку целиком
#include <tools/tools.h> 
 
// подключает только предварительные объявления
// (forward declaration)
#include <tools/forward.h>

имена, которые начинаются с подчеркивания, кстати,
в некоторых нотациях считаются игнорируемыми
(исключаются из сборки)

Сообщение от DevAlone

Потому что одни объекты, другие - "простые типы"

какая разница простые они или объекты?
это просто имена переменных.

такой ущербный дизайн
легко приводит к перекосам в мире с++

C++
1
template<typename T> auto example(T&& arg_value);

или

C++
1
template<typename T> auto example(T&& argValue);

?

на практике уже была такая попытка
наделить имя переменной информацией о её типе.

известна она как "венгерская нотация".
от неё до сих пор многие плюются.
пример того, как на ровном месте
можно усложнить себе и коллегам жизнь.

Сообщение от DevAlone

А в чём проблема?

не сказать, что здесь есть какая то проблема.
но обычно нотацию оформления имен вводят
для улучшения читабельности.
при этом часто стараются различать:

имена классов.
имена функций (функций-членов)
имена членов-данных
имена глобальных переменных.
имена локальных переменных.
имена дефайнов препроцессора.
имена перечислений (enum).

Сообщение от DevAlone

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

нафига?

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

вам в жизни проблем что ли не хватает?

@DevAlone · 05.06.2017, 23:38 **[ТС]**

Сообщение от hoggy

легко приводит к перекосам в мире с++

Ну да о темплейтах я не подумал..

Сообщение от hoggy

не сказать, что здесь есть какая то проблема.
но обычно нотацию оформления имен вводят
для улучшения читабельности.

Функции в коде видны по скобочкам(за исключеним случаев, когда адрес функции передаётся куда либо).

Сообщение от hoggy

нафига?

Для упрощения написания кода, очевидно же. К тому же транслироваться оно будет во вполне читаемый код на C++.

Сообщение от hoggy

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

Транслироваться будут только те файлы, которые изменились.

Сообщение от hoggy

и с которым не дружит ни одна из топовых систем сборки.

make же умеет вызывать скрипт перед сборкой.

@GbaLog- · 06.06.2017, 06:44

Не по теме:

Сообщение от hoggy

имена функций в такое же стиле, как и имя переменной.

а как надо? :)

@hoggy · 06.06.2017, 07:17

Сообщение от GbaLog-

а как надо?

любители верблюдов любят функции с большой буквы.
имена классов тоже.
если критично их различать,
классам ставят префикс:

C++
1
CClassName::Foo(newValue);

@GbaLog- · 06.06.2017, 07:36

Сообщение от hoggy

любители верблюдов любят функции с большой буквы.
имена классов тоже.
если критично их различать,
классам ставят префикс:

C++
1
CClassName::Foo(newValue);

но ведь отличить вызов функции-члена класса он переменой-члена класса довольно легко, почему их надо как-то отдельно именовать?

@hoggy · 06.06.2017, 09:42

Сообщение от GbaLog-

но ведь отличить вызов функции-члена класса он переменой-члена класса довольно легко, почему их надо как-то отдельно именовать?

есть ещё std`шный стиль:
пишем все с маленькой буквы,
без каких либо префиксов.

и ничо так. живут люди.
вроде не жалуются.

зачем вообще что-то как то отдельно именовать?

при годной нотации не нужна никакая подсветка синтаксиса.
код парсится в уме на автомате,
практически не напрягая мозг.

смысл любой нотации в единстве стиля и узнаваемости.

@DevAlone · 06.06.2017, 16:44 **[ТС]**

Сообщение от hoggy

смысл любой нотации в единстве стиля и узнаваемости.

Вот эта фраза главная, поэтому я и писал

Сообщение от DevAlone

в принципе можете не читать, их тыщи, этот просто нравится мне

. Главное, чтобы в рамках проекта был единый стиль, а какой именно он будет не столь важно и каждого стиля есть свои плюсы и минусы.

@dailydose · 06.06.2017, 19:17

#post9471596?

Добавлено через 21 секунду
#6?

@DevAlone · 12.06.2017, 20:59 **[ТС]**

Сообщение от hoggy

какая разница простые они или объекты?
это просто имена переменных.
такой ущербный дизайн
легко приводит к перекосам в мире с++

Сообщение от hoggy

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

Кстати, если писать различным образом функции и переменные, то в C++ тоже могут возникнуть проблемы, потому как переменная может быть указателем на функцию, функциональным объектом или лямбдой.

@hoggy · 12.06.2017, 21:28

Сообщение от DevAlone

то в C++ тоже могут возникнуть проблемы, потому как переменная может быть указателем на функцию, функциональным объектом или лямбдой.

ну дык, вот здесь как раз помогает нотация:

C++
1
2
3
4
5
6
7
8
9
10
11
void Execute(auto&& callback);
 
...
 
 
Execute(functor); //<--- функтор - объект.
// а не функция какая нибудь
 
...
 
Execute(Func); //<--- а вот здесь кормим функцией

@DevAlone · 13.06.2017, 01:43 **[ТС]**

Сообщение от hoggy

ну дык, вот здесь как раз помогает нотация:

Чем? Разве это такая прям полезная информация, знать функтор это или обычная функция?

@hoggy · 13.06.2017, 01:52

Сообщение от DevAlone

Чем? Разве это такая прям полезная информация, знать функтор это или обычная функция?

см #9

Новые блоги и статьи Все статьи Все блоги /
Использование SDL3-callbacks вместо функции main() на Android, Desktop и WebAssembly 8Observer8 24.01.2026 Если вы откроете примеры для начинающих на официальном репозитории SDL3 в папке: examples, то вы увидите, что все примеры используют следующие четыре обязательные функции, а привычная функция main(). . .	моя боль iceja 24.01.2026 Выложила интерполяцию кубическими сплайнами www. iceja. net REST сервисы временно не работают, только через Web. Написала за 56 рабочих часов этот сайт с нуля. При помощи perplexity. ai PRO , при. . .	Модель сукцессии микоризы anaschu 24.01.2026 Решили писать научную статью с неким РОманом	http://iceja.net/ математические сервисы iceja 20.01.2026 Обновила свой сайт http:/ / iceja. net/ , приделала Fast Fourier Transform экстраполяцию сигналов. Однако предсказывает далеко не каждый сигнал (см ограничения http:/ / iceja. net/ fourier/ docs ). Также. . .
http://iceja.net/ сервер решения полиномов iceja 18.01.2026 Выкатила http:/ / iceja. net/ сервер решения полиномов (находит действительные корни полиномов методом Штурма). На сайте документация по API, но скажу прямо VPS слабенький и 200 000 полиномов. . .	Расчёт переходных процессов в цепи постоянного тока igorrr37 16.01.2026 / * Дана цепь(не выше 3-го порядка) постоянного тока с элементами R, L, C, k(ключ), U, E, J. Программа находит переходные токи и напряжения на элементах схемы классическим методом(1 и 2 з-ны. . .	Восстановить юзерскрипты Greasemonkey из бэкапа браузера damix 15.01.2026 Если восстановить из бэкапа профиль Firefox после переустановки винды, то список юзерскриптов в Greasemonkey будет пустым. Но восстановить их можно так. Для этого понадобится консольная утилита. . .	Сукцессия микоризы: основная теория в виде двух уравнений. anaschu 11.01.2026 https:/ / rutube. ru/ video/ 7a537f578d808e67a3c6fd818a44a5c4/

@dailydose 671 / 217 / 88 Регистрация: 21.07.2016 Сообщений: 1,036 Записей в блоге: 2
	06.06.2017, 19:17
	#post9471596? Добавлено через 21 секунду #6? 0