Skip to content

Commit 6cb4b64

Browse files
committed
Правки curveball по PR 108
1 parent 1d203b5 commit 6cb4b64

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

1-js/03-code-quality/03-comments/article.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Комментарии
22

3-
Как мы знаем из главы <info:structure>, комментарии могут быть однострочными, начинающимися с `//`, и многострочными: `/* ... */`.
3+
Как мы знаем из главы <info:structure>, комментарии могут быть однострочными, начинающимися с `//` и многострочными: `/* ... */`.
44

55
Обычно мы их используем, чтобы описать, как и почему работает код.
66

@@ -65,7 +65,7 @@ function isPrime(n) {
6565
}
6666
```
6767

68-
Теперь мы можем легко понять код. Функция сама становится комментарием. Такой код называется *самодокументируемым*.
68+
Теперь мы можем легко понять код. Функция сама становится комментарием. Такой код называется *самоописательным*.
6969

7070
### Рецепт: создавайте функции
7171

@@ -113,7 +113,7 @@ function addJuice(container) {
113113

114114
Ещё раз, функции сами по себе описывают, что в них происходит. Тут нечего комментировать. И ещё, структура кода лучше, когда она разделена на части. Понятно, что делает каждая функция, что она принимает и что возвращает.
115115

116-
В реальности мы не можем полностью избежать "объясняющих" комментариев. Существуют сложные алгоритмы. И есть хитрые уловки для их оптимизации. Но в целом мы должны стараться писать простой и самодокументируемый код.
116+
В реальности мы не можем полностью избежать "объясняющих" комментариев. Существуют сложные алгоритмы. И есть хитрые уловки для оптимизации. Но в целом мы должны стараться писать простой и самоописательный код.
117117

118118
## Хорошие комментарии
119119

@@ -153,7 +153,7 @@ function addJuice(container) {
153153
Без подобных комментариев возможна следующая ситуация:
154154
1. Вы (или ваш коллега) открываете написанный некоторое время назад код и видите, что в нём есть что улучшить.
155155
2. Вы думаете: "Каким глупым я раньше был и насколько умнее стал сейчас", и переписываете его на "более правильный и оптимальный" вариант.
156-
3. ...Желание переписать код -- это хорошо. Но в процессе вы понимаете, что "оптимальное" решение на самом деле не такое уж и оптимальное. Вы даже смутно припоминаете, почему, так как в прошлый раз вы уже его пробовали. Вы возвращаетесь к правильному варианту, потратив время зря.
156+
3. ...Желание переписать код -- это хорошо. Но в процессе вы понимаете, что "оптимальное" решение на самом деле не такое уж и оптимальное. Вы даже смутно припоминаете почему, так как в прошлый раз вы уже его пробовали. Вы возвращаетесь к правильному варианту, потратив время зря.
157157

158158
Комментарии, объясняющие решение, очень важны. Они помогают продолжать разработку в правильном направлении.
159159

@@ -175,6 +175,6 @@ function addJuice(container) {
175175
**Избегайте комментариев:**
176176

177177
- Которые объясняют, "как работает код" и "что он делает".
178-
- Используйте их только в тех случаях, когда невозможно сделать настолько простой и самодокументируемый код, который не потребует комментариев.
178+
- Используйте их только в тех случаях, когда невозможно сделать настолько простой и самоописательный код, что он не потребует комментариев.
179179

180180
Автодокументирующие инструменты, такие как JSDoc3, также используют комментарии: они их читают и генерируют HTML-документацию (или документацию в другом формате).

0 commit comments

Comments
 (0)