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
+16-16Lines changed: 16 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -125,25 +125,25 @@ function addJuice(container) {
125
125
Документируйте параметры и использование функций
126
126
: Есть специальный синтаксис [JSDoc](https://ru.wikipedia.org/wiki/JSDoc) для документирования функций: использование, параметры, возвращаемое значение.
127
127
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
+
functionpow(x, n) {
138
+
...
139
+
}
140
+
```
141
141
142
-
Подобные комментарии позволяют нам понимать назначение функции и правильно её использовать без необходимости заглядывать в код.
142
+
Подобные комментарии позволяют нам понимать назначение функции и правильно её использовать без необходимости заглядывать в код.
143
143
144
-
Кстати, многие редакторы, такие как [WebStorm](https://www.jetbrains.com/webstorm/), прекрасно их распознают для того, чтобы выполнить автодополнение ввода и различные автоматические проверки кода.
144
+
Кстати, многие редакторы, такие как [WebStorm](https://www.jetbrains.com/webstorm/), прекрасно их распознают для того, чтобы выполнить автодополнение ввода и различные автоматические проверки кода.
145
145
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/>.
147
147
148
148
Почему задача решена именно таким способом?
149
149
: Важно то, что написано. Но то, что *не* написано, может быть даже более важным, чтобы понимать происходящее. Почему задача решена именно этим способом? Код не даёт ответа.
0 commit comments