Skip to content

Commit bbacb3a

Browse files
committed
самодокументированный
1 parent 825822a commit bbacb3a

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -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

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

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

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

0 commit comments

Comments
 (0)