Skip to content

Commit 4a850b1

Browse files
committed
Опечатки и разметка в man2.1
1 parent a495262 commit 4a850b1

File tree

1 file changed

+9
-7
lines changed
  • manuals/2/0__basic_clean_code_principles

1 file changed

+9
-7
lines changed

manuals/2/0__basic_clean_code_principles/article.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212

1313
Чтобы наглядно продемонстрировать разницу, давайте рассмотрим следующий пример.
1414

15-
% **Пример**
15+
> **Пример**
1616
Написать программу, которая определяет, является ли введённое число простым или составным.
1717
На вход программе можно подавать любое натуральное число, большее `1`.
1818
Если число простое, то программа выводит строку `prime`, иначе -- строку `composite`.
@@ -215,10 +215,11 @@ int main(void) {
215215
Отдельно каснёмся оформления арифметических выражений. Иногда внутри них опускают пробелы вокруг бинарных операторов, чтобы нагляднее показать структуру выражения и/или приоритет операций. Операторы, имеющие более высокий приоритет, пишут без пробелов, в то время как операторы более низкого приоритета — с пробелами вокруг. Посмотрите на следующий листинг с примерами:
216216
217217
Листинг 7. Примеры оформления арифметических выражений
218+
```c
218219
b*b + 4*a*c; // сначала умножение, затем сложение
219220
(num_1*num_2) / (num_3*num_4); // сначала вычисляются выражения в числителе и знаменателе
220221
(-b + determinant) / (2*a); // добавили пробелы вокруг + для улучшения читаемости
221-
222+
```
222223

223224
## Имена переменных
224225

@@ -328,15 +329,15 @@ int main(void)
328329
Даже видя условие задачи, я не сразу сообразил, что за магические числа `4990` и `8.317e+24`.
329330

330331

331-
Итак, применив всего несколько простых принципов, мы превратили нечитаемый код в хорошо структурированный и понятный чистый код.
332+
Итак, применив всего несколько простых принципов, мы превратили нечитаемую портянку инструкций языка Си в хорошо структурированный и понятный код.
332333

333334
## Комментарии — говорить или молчать?
334335

335-
Комментарии необходимы, чтобы облегчить понимание кода другим програмистам, которые будут его читать и поддерживать.
336+
Комментарии необходимы чтобы облегчить понимание кода другим програмистам, которые будут его читать и поддерживать.
336337

337-
Раньше разработчики часто добавляли в начало файла (“шапку”) информацию об авторе, версии кода и историю изменений. Это помогало координировать работу в команде и отслеживать изменения. Однако с появлением =систем управления версиями= (например, Git) необходимость в этих “шапках” отпала.
338+
Раньше разработчики часто использовали комментарии для добавления в начало файла (“шапку”) информации об авторе, версии программы, историю изменений и контактных данных. Это помогало координировать работу в команде и отслеживать изменения. Однако с появлением =систем управления версиями= (например, Git) необходимость в подобных “шапках” резко сократилась.
338339

339-
Тем не менее, комментарии по-прежнему полезны для объяснения сложных алгоритмов, неочевидных решений, ссылок на стандарты или обоснования нестандартного подхода. Однако комментарии, дублирующие очевидный код, не несут никакой пользы и только засоряют его.
340+
Тем не менее, комментарии по-прежнему полезны для объяснения сложных алгоритмов, неочевидных решений, ссылок на стандарты или объяснения нестандартных решений и трюков. Однако комментарии, дублирующие очевидный код, не несут никакой пользы и только засоряют его.
340341

341342
Листинг 11. Плохой пример использования комментариев
342343
```c
@@ -358,6 +359,7 @@ int main() {
358359
return 0;
359360
}
360361
```
362+
361363
Здесь нет ни одного полезного комментария. Эти комментарии лишь описывают очевидный код и не добавляют никакой новой информации, а наоборот, затрудняют чтение. Такие комментарии на зачётах по программированию используют нерадивые студенты, которым программу написал друг или генеративный искусственный интеллект. Им они действительно нужны, т.к. для них комментируемый код зачастую не является очевидным. =)
362364

363365
% **Принцип 7:** Избегайте избыточных и тривиальных комментариев, которые не несут полезной информации.
@@ -366,7 +368,7 @@ int main() {
366368

367369
Чтобы проиллюстрировать разумное использование комментариев, давайте усовершенствуем программу из Листинг 2 (или Листинга 9) следующим образом:
368370

369-
Листинг 12.
371+
Листинг 12. Добавим в Листинг 9 математический трюк для оптимизации перебора
370372
```c
371373
#include <stdio.h>
372374

0 commit comments

Comments
 (0)