From eefda7c8fa6d9dd48c3593a2763228a145ca6171 Mon Sep 17 00:00:00 2001 From: Andrii Hrushetskyi Date: Sun, 16 Feb 2025 10:53:21 +0100 Subject: [PATCH] fixed few small typos **In chapter 3-03 comments** --- 1-js/03-code-quality/03-comments/article.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/1-js/03-code-quality/03-comments/article.md b/1-js/03-code-quality/03-comments/article.md index 991d06f44..932b1e603 100644 --- a/1-js/03-code-quality/03-comments/article.md +++ b/1-js/03-code-quality/03-comments/article.md @@ -120,7 +120,7 @@ function addJuice(container) { Тож, пояснювальні коментарі зазвичай погані. Які ж тоді хороші? Описуйте архітектуру -: Додавайте опис компонентів вищого рівня, як вони взаємодіють, який потік управління мають у різних обставинах... Якщо коротко - огляд коду з висоту пташиного польоту. Є спеціальна мова [UML](https://uk.wikipedia.org/wiki/Unified_Modeling_Language) для побудови діаграм високорівневої архітектури коду. Її однозначно варто вчити. +: Додавайте опис компонентів вищого рівня, як вони взаємодіють, який потік управління мають у різних обставинах... Якщо коротко - огляд коду з висоти пташиного польоту. Є спеціальна мова [UML](https://uk.wikipedia.org/wiki/Unified_Modeling_Language) для побудови діаграм високорівневої архітектури коду. Її однозначно варто вчити. Документуйте параметри функції та її використання : Існує спеціальний синтаксис [JSDoc](https://uk.wikipedia.org/wiki/JSDoc) для документації функції: її використання, параметри, значення, що повертає. @@ -175,6 +175,6 @@ function pow(x, n) { **Уникайте коментарі:** - Які описують, як код працює і що він робить. -- Пишіть їх тільки у тому випадку, коли не має змоги написати простий та самоописний код, якому пояснення не потрібні. +- Пишіть їх тільки у тому випадку, коли немає змоги написати простий та самоописний код, якому пояснення не потрібні. Коментарі також використовуються інструментами для автоматичної генерації документації, наприклад JSDoc3 - вони читають їх та генерують HTML-документи (або документи в іншому форматі).