Мануал по оформлению кода программ

Author: KaDeaT

manuals/2/0__basic_clean_code_principles/article.md

@@ -0,0 +1,6 @@
+{
+  "title": "Базовые принципы чистого кода",
+  "description": "В уроке разбираются основные принципы написания чистого кода: структурирование, использование осмысленных имен переменных, избегание магических чисел и разумное использование комментариев. Примеры и советы для улучшения читаемости и поддержки кода",
+  "keywords": "чистый код, структурирование кода, именование переменных, магические числа, комментарии в коде, читаемость кода, стиль программирования, camelCase, snake_case, K&R style, clean code",
+  "canonical_link": "https://youngcoder.ru/manuals/2/basic_clean_code_principles"
+}

manuals/2/0__basic_clean_code_principles/meta.json

@@ -0,0 +1,7 @@
+## Дополнительные материалы
+
+1. Книга [А.В. Столярова "Оформление программного кода"](http://www.stolyarov.info/books/pdf/codestyle2.pdf) 
+
+2. Существует Linux стиль в расстановке фигурных скобок и отступов. В нём для функций применяется BSD стиль (фигурные скобки на новой строке), а для управляющих конструкций языка, например, `for`, `if`, `switch`, `while` и пр. используется K&R стиль (открывающая фигурная скобка на той же строке). Имено в таком стиле оформлены большинство листингов и примеров в материалах Курса.
+
+3. Крупные компании и проекты обычно имеют собственные правила, который описывает различные нюансы оформления кода программ. Такие руководства называют =стайлгайдами (style guide)=. Использование единых правил по оформлению кода делает код единообразным, ускоряют разработку и снижают когнитивную нагрузки на разработчиков, т.к. им не приходится каждый раз перестраиваться под различные стили написания кода внутри одного проекта. Естественно, использование стайлгайдов также упрощает и дальнейшую поддержку кода.

manuals/2/0__basic_clean_code_principles/practice.md

@@ -0,0 +1,7 @@
+# Оформление кода программ
+
+В этом разделе собраны уроки, посвящённые оформлению программного кода. Вы узнаете, как сделать ваш код более ясным, читаемым и поддерживаемым.
+
+Чистый код — это не просто эстетика, это основа для успешной разработки и поддержки программного обеспечения. Хорошо структурированный код облегчает понимание логики программы, упрощает внесение изменений и снижает вероятность ошибок. 
+
+В наших уроках мы рассмотрим ключевые принципы оформления программного кода, а также разберём наиболее известные стайлгайды. Эти знания помогут вам писать код, который будет понятен не только вам, но и другим разработчикам.

manuals/2/0__basic_clean_code_principles/reference.md

@@ -0,0 +1,7 @@
+{
+  "title": "Оформление кода программ",
+  "description": "В разделе собраны заметки по правильному оформлению кода программ. Рассмотрены основные принципы и правила написания чистого кода.",
+  "keywords": "чистый код, рефакторинг, красивый код, стайлгайды",
+  "canonical_link": "https://youngcoder.ru/manuals/2/",
+  "has_glory_hall": false
+}