Як зробити чистий код зрозуміліше: основні рекомендації

Основна мета при написанні коду – зробити його легким для читання і розуміння. Добре написані програми легше налагоджувати, легше підтримувати і в них менше помилок. Написання програми багато в чому схоже на написання есе. Коли ви пишете есе, ваше повідомлення буде більш переконливим, якщо воно супроводжується правильною граматикою і пунктуацією. При написанні комп’ютерних програм ви повинні слідувати тим же принципом.

Менше коду – завжди краще.


Коли справа доходить до написання програмного забезпечення, часто при запуску і написанні найперших рядків нашого класу може бути трохи більше коду, ніж необхідно. Наприклад, загальнодоступний метод в сервісі може містити кілька змінних, які не потрібні, блок логіки або оператори «якщо», які повинні бути виділені в окремий метод. Наприклад, результат методу можна використовувати безпосередньо в коді, створення змінної і присвоєння результату цієї змінної не є обов’язковим. Чистий код завжди буде зрозумілий для всіх програмістів, не залежно від однієї людини, який його написав.

Зменшіть обсяг коду в одному місці. Видаліть невикористовувані змінні. Також видаліть коментарі – код повинен бути зрозумілим.

Метод вилучення


Як довго ваш метод? Якщо в ньому більше 20 рядків, багато операторів if, циклів і т. Д., Вам слід подумати про це. Вийміть його в інший метод з власним ім’ям, яке дає уявлення про те, що він робить, чітко одним поглядом без аналізу логіки. Навіщо використовувати метод вилучення? Тому що це допомагає тримати легко читається структуру методу. Завжди краще читати один метод, який містить 20 рядків, що викликають 10 різних методів, ніж метод, що містить 400 рядків безіменній логіки і спотвореного коментаря.

Чистий код – хороший неймінг

Варто витратити деякий час на те, щоб знайти власне ім’я для створюваного нами класу, методу, змінної. Це заощадить нашим колегам багато часу. Не використовуйте абревіатури, імена повинні бути простими і зрозумілими. Наприклад, «usersAction» – це нечітке назву методу – щоб зрозуміти, що воно означає, вам потрібно заглянути всередину тіла методу. Навпаки, метод з самоочевидним ім’ям може бути «saveUserInDataBaseAndSendAnEmail». Це ім’я точно вказує, що робить метод. Усередині ви можете очікувати окремі методи з іменами: «saveUser», «sendAnEmailAboutSavedUser».

  • Змінна, ім’я повинно вказувати, які дані в ній зберігаються або яка служба ховається за ними.
  • Метод, який зчитує ім’я методу. Ви повинні точно знати, що він робить, не вдаючись у логіку.
  • Клас повинен бути названий відповідно до домену (частина логіки системи, за яку він відповідає, наприклад, доменом можуть бути платежі, рахунки і т. Д.). Якщо клас починає рости більш ніж на 200 рядків, подумайте про його розділення.

Виділимо ще раз. Чистий код означає переваги: ​​приємна робота, менше стресу, модульні тести, проста налагодження і кращу якість.

Ми знаємо, що якщо ви маєте справу з заплутаним кодом, робота з таким середовищем зажадає більше часу, нервів і енергії, ніж варто було б. Це не тому, що ви поганий програміст, а просто тому, що аналіз цього коду займає багато часу і (оскільки ми всього лише люди) засмучує і стомлює. Нікому не подобається працювати з погано зробленими кодом.

Додано: 04.01.2021
прокоментувати статтю

Залишити відповідь

Ваша e-mail адреса не оприлюднюватиметься. Обов’язкові поля позначені *

На початок
Телефон
Чат
Заявка
Меню