You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: 1-js/03-code-quality/03-comments/article.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Комментарии
2
2
3
-
Как мы знаем из главы <info:structure>, комментарии могут быть однострочными, начинающимися с `//`, и многострочными: `/* ... */`.
3
+
Как мы знаем из главы <info:structure>, комментарии могут быть однострочными, начинающимися с `//` и многострочными: `/* ... */`.
4
4
5
5
Обычно мы их используем, чтобы описать, как и почему работает код.
6
6
@@ -65,7 +65,7 @@ function isPrime(n) {
65
65
}
66
66
```
67
67
68
-
Теперь мы можем легко понять код. Функция сама становится комментарием. Такой код называется *самодокументируемым*.
68
+
Теперь мы можем легко понять код. Функция сама становится комментарием. Такой код называется *самоописательным*.
69
69
70
70
### Рецепт: создавайте функции
71
71
@@ -113,7 +113,7 @@ function addJuice(container) {
113
113
114
114
Ещё раз, функции сами по себе описывают, что в них происходит. Тут нечего комментировать. И ещё, структура кода лучше, когда она разделена на части. Понятно, что делает каждая функция, что она принимает и что возвращает.
115
115
116
-
В реальности мы не можем полностью избежать "объясняющих" комментариев. Существуют сложные алгоритмы. И есть хитрые уловки для их оптимизации. Но в целом мы должны стараться писать простой и самодокументируемый код.
116
+
В реальности мы не можем полностью избежать "объясняющих" комментариев. Существуют сложные алгоритмы. И есть хитрые уловки для оптимизации. Но в целом мы должны стараться писать простой и самоописательный код.
117
117
118
118
## Хорошие комментарии
119
119
@@ -153,7 +153,7 @@ function addJuice(container) {
153
153
Без подобных комментариев возможна следующая ситуация:
154
154
1. Вы (или ваш коллега) открываете написанный некоторое время назад код и видите, что в нём есть что улучшить.
155
155
2. Вы думаете: "Каким глупым я раньше был и насколько умнее стал сейчас", и переписываете его на "более правильный и оптимальный" вариант.
156
-
3. ...Желание переписать код -- это хорошо. Но в процессе вы понимаете, что "оптимальное" решение на самом деле не такое уж и оптимальное. Вы даже смутно припоминаете, почему, так как в прошлый раз вы уже его пробовали. Вы возвращаетесь к правильному варианту, потратив время зря.
156
+
3. ...Желание переписать код -- это хорошо. Но в процессе вы понимаете, что "оптимальное" решение на самом деле не такое уж и оптимальное. Вы даже смутно припоминаете почему, так как в прошлый раз вы уже его пробовали. Вы возвращаетесь к правильному варианту, потратив время зря.
157
157
158
158
Комментарии, объясняющие решение, очень важны. Они помогают продолжать разработку в правильном направлении.
159
159
@@ -175,6 +175,6 @@ function addJuice(container) {
175
175
**Избегайте комментариев:**
176
176
177
177
- Которые объясняют, "как работает код" и "что он делает".
178
-
- Используйте их только в тех случаях, когда невозможно сделать настолько простой и самодокументируемый код, который не потребует комментариев.
178
+
- Используйте их только в тех случаях, когда невозможно сделать настолько простой и самоописательный код, что он не потребует комментариев.
179
179
180
180
Автодокументирующие инструменты, такие как JSDoc3, также используют комментарии: они их читают и генерируют HTML-документацию (или документацию в другом формате).
0 commit comments