diff --git a/1-js/03-code-quality/02-coding-style/article.md b/1-js/03-code-quality/02-coding-style/article.md index ad8039e4c..92ed9392c 100644 --- a/1-js/03-code-quality/02-coding-style/article.md +++ b/1-js/03-code-quality/02-coding-style/article.md @@ -2,7 +2,7 @@ Наш код повинен бути настільки зрозумілим та читабельним, наскільки це можливо. -Насправді мистецтво програмування — це брати складну задачу і писати код, який одночасно і розв'язує задачу, і залишається зрозумілим людині. Саме тут хороший стиль коду стає у пригоді. +Насправді мистецтво програмування — це брати складну задачу і писати код, який одночасно і розв'язує задачу, і залишається зрозумілим людині. І хороший стиль коду тут неабияк стає у пригоді. ## Синтаксис @@ -42,7 +42,7 @@ if (n < 0) { ### Фігурні дужки -У більшості JavaScript проєктів фігурні дужки написані у так званому "Єгипетському" стилі, де дужка що відкриває блок знаходиться не на новому рядку, а на тому ж, що й відповідне ключове слово. Також потрібно додавати перед нею пробіл. Наприклад: +У більшості JavaScript проєктів фігурні дужки написані у так званому "Єгипетському" стилі, де дужка, що відкриває блок знаходиться не на новому рядку, а на тому ж, що й відповідне ключове слово. Також потрібно додавати перед нею пробіл. Наприклад: ```js if (condition) { @@ -104,7 +104,7 @@ if ( } ``` -Максимальну довжину рядка визначається командою. Зазвичай це `80` або `120` символів. +Максимальну довжину рядка слід встановлювати на рівні всієї команди (людської, від слова team). Зазвичай встановлюють `80` або `120` символів. ### Відступи @@ -151,7 +151,7 @@ if ( Крапку з комою треба ставити після кожного виразу, навіть тоді, коли є можливість їх пропустити. -Є мови програмування, у яких крапка з комою є дійсно необов'язковими та рідко використовуються. Проте у JavaScript є ситуації коли перенесення строки не інтерпретується як крапка з комою, залишаючи код вразливим до помилок. Більше детально про це знайдете у розділі . +Є мови програмування, у яких крапка з комою є дійсно необов'язковими та рідко використовуються. Проте у JavaScript є ситуації коли перенесення строки не інтерпретується як крапка з комою, залишаючи код вразливим до помилок. Детальніше про це можна почитати в розділі . Якщо ви досвідчений JavaScript програміст, ви можете обрати стиль коду без крапки з комою, наприклад [StandardJS](https://standardjs.com/). Інакше, краще використовувати крапку з комою для того, щоб уникнути підводних каменів. Більшість розробників використовують крапку з комою. @@ -180,7 +180,7 @@ for (let i = 0; i < 10; i++) { } ``` -Схожим чином ми можемо змінити `if/else` та `return`. +Схожим чином ми можемо змінити `if`/`else` та `return`. Наприклад, дві конструкції нижче є ідентичними. @@ -275,13 +275,13 @@ function pow(x, n) { Причиною цього є те, що коли ми читаємо код, перш за все ми хочемо зрозуміти *що він робить*. Якщо головний код іде першим - це стає зрозумілим з самого початку. Тоді, можливо ми навіть не будемо читати функції взагалі, особливо якщо їх імена відповідають тому, що вони роблять. -## Посібники зі Стилю Коду +## Style Guide (Посібник зі Стилю Коду) -Посібник зі стилю коду містить загальні правила "як писати" код, наприклад, які лапки використовувати, скільки пробілів ставити для відступу, максимальну довжину рядка, і таке інше. Тобто, багато дрібниць. +Style Guide містить загальні правила "як писати" код. Наприклад які лапки використовувати, скільки пробілів ставити для відступу, максимальну довжину рядка, і таке інше. Тобто, багато дрібниць. -Коли всі члени команди використовують посібник зі стилю, код виглядає однаковим, незалежно від того, хто з команди його написав. +Коли всі члени команди використовують однаковий style guide, код виглядає однаковим, незалежно від того, хто з команди його написав. -Звичайно, кожна команда може завжди створити свій посібник зі стилю, але зазвичай в цьому не має потреби. Є багато посібників, серед яких можна вибрати найбільш відповідний. +Звичайно, кожна команда може завжди створити свій style guide, але зазвичай в цьому не має потреби. Є багато посібників, серед яких можна вибрати найбільш відповідний. Деякі популярні посібники: @@ -313,7 +313,7 @@ function pow(x, n) { 1. Встановіть [Node.js](https://nodejs.org/). 2. Встановіть ESLint, використовуючи команду `npm install -g eslint` (npm – це менеджер JavaScript пакетів (модулів)). -3. Створіть файл конфігурації `.eslintrc` в корні вашого JavaScript проєкту (у директорії, що містить всі ваші файли). +3. Створіть файл конфігурації `.eslintrc` в корені вашого JavaScript проєкту (у директорії, що містить всі ваші файли). 4. Встановіть/увімкніть плагін для вашого редактора, який інтегрується з ESLint. Більшість редакторів мають такий плагін. Ось приклад файлу `.eslintrc`: