Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Fixed few small typos in Comments chapter#691

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Open
Andrii256 wants to merge1 commit intojavascript-tutorial:master
base:master
Choose a base branch
Loading
fromAndrii256:03-03-comments
Open
Changes fromall commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions1-js/03-code-quality/03-comments/article.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -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) для документації функції: її використання, параметри, значення, що повертає.
Expand DownExpand Up@@ -175,6 +175,6 @@ function pow(x, n) {
**Уникайте коментарі:**

- Які описують, як код працює і що він робить.
- Пишіть їх тільки у тому випадку, колине має змоги написати простий та самоописний код, якому пояснення не потрібні.
- Пишіть їх тільки у тому випадку, колинемає змоги написати простий та самоописний код, якому пояснення не потрібні.

Коментарі також використовуються інструментами для автоматичної генерації документації, наприклад JSDoc3 - вони читають їх та генерують HTML-документи (або документи в іншому форматі).

[8]ページ先頭

©2009-2025 Movatter.jp