diff --git a/1-js/03-code-quality/03-comments/article.md b/1-js/03-code-quality/03-comments/article.md index 749d18fae5..c4c2384a21 100644 --- a/1-js/03-code-quality/03-comments/article.md +++ b/1-js/03-code-quality/03-comments/article.md @@ -125,25 +125,25 @@ function addJuice(container) { Документируйте параметры и использование функций : Есть специальный синтаксис [JSDoc](https://ru.wikipedia.org/wiki/JSDoc) для документирования функций: использование, параметры, возвращаемое значение. - Например: - ```js - /** - * Возвращает x, возведённое в n-ную степень. - * - * @param {number} x Возводимое в степень число. - * @param {number} n Степень, должна быть натуральным числом. - * @return {number} x, возведённое в n-ную степень. - */ - function pow(x, n) { - ... - } - ``` +Например: +```js +/** + * Возвращает x, возведённое в n-ную степень. + * + * @param {number} x Возводимое в степень число. + * @param {number} n Степень, должна быть натуральным числом. + * @return {number} x, возведённое в n-ную степень. + */ +function pow(x, n) { + ... +} +``` - Подобные комментарии позволяют нам понимать назначение функции и правильно её использовать без необходимости заглядывать в код. +Подобные комментарии позволяют нам понимать назначение функции и правильно её использовать без необходимости заглядывать в код. - Кстати, многие редакторы, такие как [WebStorm](https://www.jetbrains.com/webstorm/), прекрасно их распознают для того, чтобы выполнить автодополнение ввода и различные автоматические проверки кода. +Кстати, многие редакторы, такие как [WebStorm](https://www.jetbrains.com/webstorm/), прекрасно их распознают для того, чтобы выполнить автодополнение ввода и различные автоматические проверки кода. - Также существуют инструменты, например, [JSDoc 3](https://github.com/jsdoc3/jsdoc), которые умеют генерировать HTML-документацию из комментариев. Получить больше информации о JSDoc вы можете здесь: . +Также существуют инструменты, например, [JSDoc 3](https://github.com/jsdoc3/jsdoc), которые умеют генерировать HTML-документацию из комментариев. Получить больше информации о JSDoc вы можете здесь: . Почему задача решена именно таким способом? : Важно то, что написано. Но то, что *не* написано, может быть даже более важным, чтобы понимать происходящее. Почему задача решена именно этим способом? Код не даёт ответа.