Структура проекта - разбор для новичков
Создавая программный продукт, важно наладить его структуру, что облегчит жизнь как тебе, так и другим программистам, работающим над ним. Организованный код проще поддерживать, отслеживать, модифицировать и расширять. Порядок в коде – залог успеха проекта.
Файловая система
* Не создавай все файлы в одном каталоге.
* Группируй файлы по функционалу или типу данных.
* Называй файлы информативно, чтобы было ясно, что внутри.
Каталоги
* Корневой каталог содержит основные модули.
* Вложенные каталоги хранят подмодули и вспомогательные файлы.
* Избегай глубокой вложенности каталогов.
Файлы
* Храни код одного модуля в одном файле.
* Не создавай слишком большие файлы.
* Разбивай логически связанные фрагменты кода на функции и классы.
Структура кода
* Используй однозначные и понятные имена для переменных, функций и классов.
* Комментируй важные части кода, объясняя его функциональность.
* Соблюдай соглашения об именовании и форматировании кода в соответствии со стандартами.
* Разделяй код на логические блоки, выделяя его пробелами и отступами.
* Тестируй код как можно чаще, чтобы выявить ошибки на ранней стадии.
