15 І більш найкращих методів написання суперчітаемого коду

У цій статті докладно описані п'ятнадцять найважливіших і кращих методів, застосовуваних для написання Новомосковскемого коду.

Ось ще один приклад, коли я викликаю функцію з сторонньої бібліотеки:

2 Узгоджені відступи

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

Є кілька способів введення відступів в код.

Я зазвичай користувався способом № 2, але недавно переключився на спосіб № 1. Але це справа смаку. Не існує «найкращого» способу, яким всі повинні слідувати. Власне, найкращий спосіб - бути послідовним. Якщо ви - учасник команди або вносите в проект код, потрібно дотримуватися того способу, який використовується в проекті.

Способи введення відступів не завжди можна повністю відрізнити один від іншого. Іноді в них змішуються різні правила. Наприклад, в стандартах кодування PEAR відкриває дужка «

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

4. Угруповання коду

Найчастіше різні завдання вимагають декількох рядків коду. Рекомендується зберігати ці завдання в рамках окремих блоків коду з декількома пропусками між ними.

Ось простий приклад:

5. Схема послідовного найменування

Сам PHP іноді винен в тому, що не слід схемами послідовного найменування:

strpos () vs. str_split ()

imagetypes () vs. image_type_to_extension ()

Перш за все, в іменах повинні бути розмежовані слова. Два найпопулярніших варіанти:

camelCase: Перша літера кожного слова починається з великої літери, за винятком першого слова.

underscores: Підкреслення між словами, що тут: mysql_real_escape_string ().

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

Ці угоди також можуть бути змішаними. Деякі вважають за краще використовувати для процесуальних функцій і назв класів підкреслення, а для назв методів - camelCase:

Повторюю, не існує очевидного «найкращого» способу, крім послідовного.

6.Прінціп DRY

DRY розшифровується як Do not Repeat Yourself (Не повторювати). Також відомий як DIE: Duplication is Evil (Повторення - зло).

Цей принцип говорить:

Призначення більшості додатків (або комп'ютерів в цілому) - в автоматизації повторюваних завдань. Цей принцип повинен дотримуватися у всьому коді, навіть в веб-додатках. Один і той же шматок коду не повинен повторюватися знову і знову.

7. Уникайте глибоких вкладень умовних операторів

Щоб зробити приклад більш ясним, треба внести зміни, щоб зменшити рівень вкладеності:

8. Обмежуйте довжину рядків

Дуже корисно уникати написання дуже довгих рядків коду.

Якщо ви прямуєте раді «уникати глибоких вкладень умовних операторів», то це так само буде сприяти тому, щоб довжина рядків коди залишалася в розумних розмірах.

9. Організація файлів і папок

Технічно ви можете записати код всього програми в один файл. Але для читання і підтримки це стане кошмаром.

Під час моїх перших проектів з програмування я дізнався про ідею створення «включених файлів». Однак я все ще був дуже далекий від організованості. Я створював папку «inc» з двома файлами всередині: db.php і functions.php. З ростом додатків файл функцій ставав величезним і складно підтримуваним.

Одним з кращих підходів до вирішення цієї проблеми є використання framework'ов, або їх імітація за допомогою структури папок. Ось як виглядає CodeIgniter:

10. Послідовні імена проміжних змінних

Зазвичай назви змінних повинні бути інформативними і містити одне або більше слів. Але це не обов'язково відноситься до проміжних змінним. Їх імена можуть бути настільки короткими, що можуть складатися всього з одного знака.

Рекомендується використовувати одні і ті ж назви для тих проміжних змінних, які грають однакову роль. Ось приклади того, як я зазвичай використовую їх в коді:

11. Пишіть зарезервовані слова SQL прописними буквами

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

Навіть якщо зарезервовані слова SQL і назви функцій нечутливі до регістру, їх зазвичай пишуть з великими букви, щоб відрізнити від назв таблиць і стовпців.

12. Відокремлюйте код і дані

Ось інший принцип, який застосовується майже до всіх мов програмування в будь-якому середовищі. У разі веб-розробки термін «дані» зазвичай передбачає вихідні дані HTML.

Коли багато років тому вперше вийшов PHP, він в основному розглядався як движок шаблонів. Мати великі HTML-файли з кількома рядками коду всередині них було звичайною справою. Однак за багато років все змінилося і вебсайти стали набагато більш динамічними і функціональними. Зараз код - величезна частина веб-додатки, і змішування його з HTML - не дуже гарна практика.

Ви можете або самі дотримуватися цього правила в ваших додатках, або користуватися при розробці додатковими інструментами (движки шаблонів, frameworks або CMS) і просто дотримуватися прийнятих в них угоди.

Популярні фреймворкі PHP: