Skip to content

Commit 161f3e2

Browse files
authored
Merge pull request #21 from DenisKolodich/KD_manual_2
Небольшие правки
2 parents 324bcb9 + a84c898 commit 161f3e2

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

manuals/2/0__basic_clean_code_principles/article.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -273,10 +273,10 @@ int main() {
273273

274274
### CamelCase и snake_case
275275

276-
1. =Стиль **CamelCase**= -- каждое новое записывается с заглавной буквы. Название CamelCase связано с тем, что заглавные буквы создают визуальное впечатление “горбов”, как у верблюда. Вот несколько примеров имён переменных, записанных в стиле CamelCase: `DayInMonth`, `NumberTables`, `SecondsPassedFromFirstShot`.
276+
1. =Стиль **CamelCase**= -- каждое новое слово записывается с заглавной буквы. Название CamelCase связано с тем, что заглавные буквы создают визуальное впечатление “горбов”, как у верблюда. Вот несколько примеров имён переменных, записанных в стиле CamelCase: `DayInMonth`, `NumberTables`, `SecondsPassedFromFirstShot`.
277277
Существует разновидность этого стиля, где первую букву имени переменной делают строчной, а не заглавной, например: `dayInMonth`.
278278

279-
2. =Стиль **snake_case**= -- слова разделяются нижним подчёркиванием и все буквы обычно строчные. Такое название связано с тем, что нижние подчеркивания визуально напоминают изгибы змеи. Примеры имён переменных, записанных в стиле snake_case: `days_in_month`, `number_tables`, `second_passed_from_first_shot`.
279+
2. =Стиль **snake_case**= -- слова разделяются нижним подчёркиванием и все буквы обычно строчные. Такое название связано с тем, что нижние подчеркивания визуально напоминают изгибы змеи. Примеры имён переменных, записанных в стиле snake_case: `days_in_month`, `number_tables`, `seconds_passed_from_first_shot`.
280280

281281
Выбор одного из этих стилей -- вопрос личных предпочтений или соглашений, принятых в команде. Главное придерживаться выбранного стиля последовательно во всем проекте.
282282

@@ -424,4 +424,4 @@ int main(void){
424424
5. Используйте единый стиль расстановки отступов, фигурных скобок и именования переменных.
425425
6. Избегайте использования "магических" чисел.
426426
7. Избегайте избыточных и тривиальных комментариев.
427-
8. Чтобы код был понятен международному сообществу разработчиков, пишите комментарии на английском языке.
427+
8. Чтобы код был понятен международному сообществу разработчиков, пишите комментарии на английском языке.

manuals/2/0__basic_clean_code_principles/reference.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,4 @@
44

55
2. Существует Linux стиль в расстановке фигурных скобок и отступов. В нём для функций применяется BSD стиль (фигурные скобки на новой строке), а для управляющих конструкций языка, например, `for`, `if`, `switch`, `while` и пр. используется K&R стиль (открывающая фигурная скобка на той же строке). Именно этого стиля я придерживаюсь при оформлении большинства листингов и примеров в материалах Курса.
66

7-
3. Крупные компании и проекты обычно имеют собственные правила, который описывает различные нюансы оформления кода программ. Такие руководства называют =стайлгайдами (style guide)=. Использование единых правил по оформлению кода делает код единообразным, ускоряют разработку и снижают когнитивную нагрузки на разработчиков, т.к. им не приходится каждый раз перестраиваться под различные стили написания кода внутри одного проекта. Естественно, использование стайлгайдов также упрощает и дальнейшую поддержку кода.
7+
3. Крупные компании и проекты обычно имеют собственные правила, которые описывают различные нюансы оформления кода программ. Такие руководства называют =стайлгайдами (style guide)=. Использование единых правил по оформлению кода делает его единообразным, ускоряет разработку и снижает когнитивные нагрузки на разработчиков, т.к. им не приходится каждый раз перестраиваться под различные стили написания кода внутри одного проекта. Естественно, использование стайлгайдов также упрощает и дальнейшую поддержку кода.

0 commit comments

Comments
 (0)