16 приёмов написания супер читабельного кода

Читабельность кода - это очень больная тема, и ей нужно уделять должное внимание. В этой статье вы узнаете о 16 приёмах, которые помогут вам продвинуться в этой теме.

1. Комментарии и Документация

IDE становятся всё более популярны в мире разработчиков, т.к. они предоставляют удобные инструменты для комментирования и документирования кода.

Вот пример:

Комментарии, которые я добавил перед объявлением функции, можно прочитать в любой части программ, где я использую данную функцию.

Вот ещё пример вызова собственного метода:

В этом примере стиль комментирования основан на PHPDoc, а IDE, которой я пользуюсь, - Aptana.

2. Отступы

Я полагаю, что вы уже знаете о важности отступов в вашем коде. Вообще существует несколько стилей форматирования кода.

Стиль 1:

function foo() {  
    if ($maybe) {  
        do_it_now();  
        again();  
    } else {  
        abort_mission();  
    }  
    finalize();  
}  

Стиль 2:

function foo()  
{  
    if ($maybe)  
    {  
        do_it_now();  
        again();  
    }  
    else  
    {  
        abort_mission();  
    }  
    finalize();  
}  

Стиль 3:

function foo()  
{   if ($maybe)  
    {   do_it_now();  
        again();  
    }  
    else  
    {   abort_mission();  
    }  
    finalize();  
}  

Лично я чаще всего использую стиль номер #2, но иногда перехожу и на #1. Но это всё конечно же дело вкуса. Скорее всего не существует самого “лучшего” стиля, который подошёл бы абсолютно всем. Этим правилам, в первую очередь, нужно следовать тем, кто работает в команде или участвует в написании открытых проектов.

Также существуют стили, которые объединяют некоторые характеристики. К примеру, стандарты написания кода PEAR, где фигурная скобка "{" в условных операторах остаётся на той же строке, а в функциях переносится.

Стиль PEAR:

function foo()  
{                     // на новой строке  
    if ($maybe) {     // на той же строке  
        do_it_now();  
        again();  
    } else {  
        abort_mission();  
    }  
    finalize();  
}  

Также следует отметить, что в этом стиле вместо табов используются 4 пробела.

Тут вы сможете узнать больше о различных стилях.

3. Избегайте лишних комментариев

Да, комментирование кода - это хорошо; однако тут не нужно перебарщивать. Вот пример:

// получаем код страны
$country_code = get_country_code($_SERVER['REMOTE_ADDR']);  
  
// если страна US  
if ($country_code == 'US') {  
  
    // отобразить форму
    echo form_input_state();  
}  

Если работа кода очевидна, то скорее всего не следует писать лишние комментарии.

Если уж не имётся, то можно их немного сократить:

// отобразить форму, если страна US
$country_code = get_country_code($_SERVER['REMOTE_ADDR']);  
if ($country_code == 'US') {  
    echo form_input_state();  
}  

4. Группирование кода

Чаще всего некоторые задачи требуют написания нескольких строк кода. Поэтому лучше всего объединять такие задачи в отдельные блоки, разделённые пробелами.

Вот простой пример:

// получить список форумов
$forums = array();  
$r = mysql_query("SELECT id, name, description FROM forums");  
while ($d = mysql_fetch_assoc($r)) {  
    $forums []= $d;  
}  
  
// загрузить шаблон
load_template('header');  
load_template('forum_list',$forums);  
load_template('footer');  

Если вы добавите комментарий перед началом каждого блока, то это ещё больше улучшит читабельность вашего кода.

5. Схема именования

Иногда даже в языке PHP можно найти противоречия именования функций. И вот многочисленные примеры:

• strpos() против str_split()
• imagetypes() против image_type_to_extension()

Существует несколько популярных стилей:

• camelCase: первая буква каждого нового слова заглавная.
• underscores: Подчёркивание между словами: mysql_real_escape_string().

Если смешивать эти техники, то рано или поздно можно попасть в неловкую ситуацию. Если вы работаете над проектом, в котором применяется одна из этих техник, то вам надо следовать их примеру. Всё ещё может зависеть от языка программирования. К примеру, большинство Java разработчиков используют camelCase а PHP разработчики предпочитают underscores.

Но и тут не обошлось без гибрида. Некоторые разработчики используют подчёркивания в именовании классов и методов (вне классов), а в остальных случаях используют camelCase:

class Foo_Bar {  
  
    public function someDummyMethod() {  
  
    }  
  
}  
  
function procedural_function_name() {  
  
}  

Ещё раз скажу, что лучшего стиля не бывает. Просто нужно чего-то придерживаться.

6. Принцип DRY

DRY (Don’t Repeat Yourself) - не повторяйся. Так же известно как DIE: Дублирование - это зло.

Главная задача любой системы, будь то веб приложение или что-то ещё, - автоматизировать повторяющиеся задачи. Этому принципу нужно следовать всегда и везде, особенно если ты разработчик. Один и тот же кусок кода не должен повторяться снова и снова.

К примеру, большинство веб приложений состоит из одной и более страниц. Понятное дело, что на этих страницах будут присутствовать одинаковые элементы. Заголовок, футер - самые яркие примеры. Вы удивитесь, но многие люди всё ещё дублирует эти элементы на каждой странице.

$this->load->view('includes/header');  
  
$this->load->view($main_content);  
  
$this->load->view('includes/footer');  

7. Избегайте глубокой вложенности

Читабельность кода резко уменьшается, если у вас глубокая вложенность.

function do_stuff() {  
  
// ...  
  
    if (is_writable($folder)) {  
  
        if ($fp = fopen($file_path,'w')) {  
  
            if ($stuff = get_some_stuff()) {  
  
                if (fwrite($fp,$stuff)) {  
  
                    // ...  
  
                } else {  
                    return false;  
                }  
            } else {  
                return false;  
            }  
        } else {  
            return false;  
        }  
    } else {  
        return false;  
    }  
}  

Для того чтобы исправить ситуацию, вам следует пересмотреть принцип работы вашего кода и оптимизировать его:

function do_stuff() {  
  
// ...  
  
    if (!is_writable($folder)) {  
        return false;  
    }  
  
    if (!$fp = fopen($file_path,'w')) {  
        return false;  
    }  
  
    if (!$stuff = get_some_stuff()) {  
        return false;  
    }  
  
    if (fwrite($fp,$stuff)) {  
        // ...  
    } else {  
        return false;  
    }  
}  

8. Лимит длины строки

Всем известно, что процесс чтения становится куда приятней, когда текст разбит на колонки. Это главная причина, по которой наши газеты выглядят именно так:

Подобную технику можно применить и к нашему коду:

// плохо
$my_email->set_from('
 Этот e-mail адрес защищен от спам-ботов, для его просмотра у Вас должен быть включен Javascript
 ')->add_to('
 Этот e-mail адрес защищен от спам-ботов, для его просмотра у Вас должен быть включен Javascript
 ')->set_subject('Methods Chained')->set_body('Some long message')->send();  
  
// хорошо
$my_email  
    ->set_from('
 Этот e-mail адрес защищен от спам-ботов, для его просмотра у Вас должен быть включен Javascript
 ')  
    ->add_to('
 Этот e-mail адрес защищен от спам-ботов, для его просмотра у Вас должен быть включен Javascript
 ')  
    ->set_subject('Methods Chained')  
    ->set_body('Some long message')  
    ->send();  
  
// плохо
$query = "SELECT id, username, first_name, last_name, status FROM users LEFT JOIN user_posts USING(users.id, user_posts.user_id) WHERE post_id = '123'";  

// плохо 
$query = "SELECT id, username, first_name, last_name, status 
    FROM users 
    LEFT JOIN user_posts USING(users.id, user_posts.user_id) 
    WHERE post_id = '123'";

Большинство разработчиков придерживаются лимита в 80 и 120 символов.

9. Организация Файлов и Папок

Технически вы можете поместить весь код вашего приложения в один файл :) Но что вы будете делать, когда надо будет что-то изменить или добавить.

Помню свои первые проекты, в которых я присоединял файлы. Однако организация у меня сильно хромала. Я создавал папку “inc”, в которой располагал несколько файлов: db.php и functions.php. В процессе написания приложения эта папка пухла и пухла и в конечном итоге было трудно понять что где.

Чтобы решить эту проблему лучше пользоваться различного рода фрэймворками или хотя бы придерживаться их структуры. Вот так выглядит проект на CodeIgniter:

10. Названия переменных

Вообще имена переменных должны быть полностью осмысленными - это в идеальном случае. Для временных переменных можно сделать исключение.

Давайте рассмотрим несколько примеров:

// $i для циклов  
for ($i = 0; $i < 100; $i++) {  
  
    // $j для вложенных циклов  
    for ($j = 0; $j < 100; $j++) {  
  
    }  
}  
  
// $ret для возвращаемых переменных  
function foo() {  
    $ret['bar'] = get_bar();  
    $ret['stuff'] = get_stuff();  
  
    return $ret;  
}  
  
// $k и $v для foreach  
foreach ($some_array as $k => $v) {  
  
}  
  
// $q, $r и $d для mysql  
$q = "SELECT * FROM table";  
$r = mysql_query($q);  
while ($d = mysql_fetch_assocr($r)) {  
  
}  
  
// $fp для работы с файлами  
$fp = fopen('file.txt','w');  

11 - Пишите ключевые слова в SQL заглавными буквами

Большинство веб приложений взаимодействуют с базами данных. Если вы сами пишите SQL запросы, то их тоже нужно оформлять соответствующим образом... Тут ничего сложного нет. Просто пишите ключевые слова заглавными буквами.

SELECT id, username FROM user;  
  
UPDATE user SET last_login = NOW()  
WHERE id = '123'  
  
SELECT id, username FROM user u  
LEFT JOIN user_address ua ON(u.id = ua.user_id)  
WHERE ua.state = 'NY'  
GROUP BY u.id  
ORDER BY u.username  
LIMIT 0,20  

12. Разделяйте код и данные

Это ещё один принцип, который поможет вам писать более понятные программы. Он заключается в том, чтобы вы готовили данные в одном месте (допустим моделях), а взаимодействовали с ними в другом.

Когда PHP только начинал развиваться, он больше был похож на систему шаблонов. Проекты на данном языке содержали смешанный HTML и PHP код. Сейчас всё изменилось, и всем следует переходить на новый уровень написания приложений.

Вы можете сами выработать для себя какой-то особый стиль, а можете воспользоваться самыми популярными на сегодняшний день средствами.

Популяреные PHP Фрэймворки:

Системы Шаблонов:

Популярные CMS

13. Специальный синтаксис для шаблонов

Если вы не хотите использовать систему шаблонов, то вам скорее всего придётся выработать свой собственный стиль внедрения PHP кода в HTML.

А вот и пример:

<div class="user_controls">  
    <?php if ($user = Current_User::user()): ?>  
        Hello, <em><?php echo $user->username; ?></em> <br/>  
        <?php echo anchor('logout', 'Logout'); ?>  
    <?php else: ?>  
        <?php echo anchor('login','Login'); ?> |  
        <?php echo anchor('signup', 'Register'); ?>  
    <?php endif; ?>  
</div>  
  
<h1>My Message Board</h1>  
  
<?php foreach($categories as $category): ?>  
  
    <div class="category">  
  
        <h2><?php echo $category->title; ?></h2>  
  
        <?php foreach($category->Forums as $forum): ?>  
  
            <div class="forum">  
  
                <h3>  
                    <?php echo anchor('forums/'.$forum->id, $forum->title) ?>  
                    (<?php echo $forum->Threads->count(); ?> threads)  
                </h3>  
  
                <div class="description">  
                    <?php echo $forum->description; ?>  
                </div>  
  
            </div>  
  
        <?php endforeach; ?>  
  
    </div>  
  
<?php endforeach; ?> 

Такая техника позволит вам избежать лишних скобок. Также такой код удачно вписывается в HTML контекст.

14. Процедуральный и объектно ориентированный подходы

Объектно ориентированное программирование поможет вам придерживаться более или менее чёткой структуры, но это всё не значит, что вы должны отступать от процедуральных принципов написания приложений.

Объекты прекрасно подходят для представления данных. Пример:

class User {  
  
    public $username;  
    public $first_name;  
    public $last_name;  
    public $email;  
  
    public function __construct() {  
        // ...  
    }  
  
    public function create() {  
        // ...  
    }  
  
    public function save() {  
        // ...  
    }  
  
    public function delete() {  
        // ...  
    }  
  
}  

Процедуральные методы имеют свою специфическую пользу.

function capitalize($string) {  
  
    $ret = strtoupper($string[0]);  
    $ret .= strtolower(substr($string,1));  
    return $ret;  
  
}  

15. Читайте Open Source Код

Обычно проекты Open Source пишутся большим количеством разработчиков. С этой точки зрения, изучение написанного кода в подобных проектах может помочь вам набраться опыта. Так что не жалейте на это времени.

16. Рефакторинг

Рефакторинг - это изменеие кода без потери функциональности. Его также можно применять для улучшения читабельности.Тут нет места исправлению багов или добавлению функциональности. Вы просто немного меняете структуру вашего кода.

Надеюсь, эта статья была вам полезна! Я что-то упустил? Поделитесь вашим опытом!

• Комментарии