Skip to content

Commit d9b1300

Browse files
authored
Merge pull request #1537 from Rnbsov/patch-24
fix indents
2 parents e91fbec + eba8d1c commit d9b1300

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

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

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -125,25 +125,25 @@ function addJuice(container) {
125125
Документируйте параметры и использование функций
126126
: Есть специальный синтаксис [JSDoc](https://ru.wikipedia.org/wiki/JSDoc) для документирования функций: использование, параметры, возвращаемое значение.
127127

128-
Например:
129-
```js
130-
/**
131-
* Возвращает x, возведённое в n-ную степень.
132-
*
133-
* @param {number} x Возводимое в степень число.
134-
* @param {number} n Степень, должна быть натуральным числом.
135-
* @return {number} x, возведённое в n-ную степень.
136-
*/
137-
function pow(x, n) {
138-
...
139-
}
140-
```
128+
Например:
129+
```js
130+
/**
131+
* Возвращает x, возведённое в n-ную степень.
132+
*
133+
* @param {number} x Возводимое в степень число.
134+
* @param {number} n Степень, должна быть натуральным числом.
135+
* @return {number} x, возведённое в n-ную степень.
136+
*/
137+
function pow(x, n) {
138+
...
139+
}
140+
```
141141

142-
Подобные комментарии позволяют нам понимать назначение функции и правильно её использовать без необходимости заглядывать в код.
142+
Подобные комментарии позволяют нам понимать назначение функции и правильно её использовать без необходимости заглядывать в код.
143143

144-
Кстати, многие редакторы, такие как [WebStorm](https://www.jetbrains.com/webstorm/), прекрасно их распознают для того, чтобы выполнить автодополнение ввода и различные автоматические проверки кода.
144+
Кстати, многие редакторы, такие как [WebStorm](https://www.jetbrains.com/webstorm/), прекрасно их распознают для того, чтобы выполнить автодополнение ввода и различные автоматические проверки кода.
145145

146-
Также существуют инструменты, например, [JSDoc 3](https://github.com/jsdoc3/jsdoc), которые умеют генерировать HTML-документацию из комментариев. Получить больше информации о JSDoc вы можете здесь: <http://usejsdoc.org/>.
146+
Также существуют инструменты, например, [JSDoc 3](https://github.com/jsdoc3/jsdoc), которые умеют генерировать HTML-документацию из комментариев. Получить больше информации о JSDoc вы можете здесь: <http://usejsdoc.org/>.
147147

148148
Почему задача решена именно таким способом?
149149
: Важно то, что написано. Но то, что *не* написано, может быть даже более важным, чтобы понимать происходящее. Почему задача решена именно этим способом? Код не даёт ответа.

0 commit comments

Comments
 (0)