РЭДЛАЙН
Лучшие решения для Вас и Вашего бизнеса!
На нашем сайте вы можете получить информацию о веб-разработке, обслуживании и продвижении сайта. Интернет-маркетинге. SEO (поисковой оптимизации). Контекстной и медийной рекламе в Интернете. SMM. Регистрации доменов и хостинговых услугах. И современном дизайне сайтов. Вообщем того что касается веб-разработки, а также много другой полезной информации из мира интернета, бизнеса и интернет-технологий...
Создаем доступные и современные сайты, которые работают! Обслуживаем и эффективно продвигаем интернет-проекты с 2006 года!
Главная Web-мастеру 16 приёмов написания супер читабельного кода


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. Рефакторинг

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

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

Источник: http://feedproxy.google.com/~r/ruseller/CdHX/~3/IGnD888gCzs/lessons.php

16 приёмов написания супер читабельного кода | | 2012-06-19 12:07:40 | | Статьи Web-мастеру | | Читабельность кода - это очень больная тема, и ей нужно уделять должное внимание. В этой статье вы узнаете о 16 приёмах, которые помогут вам продвинуться в этой теме.1. Комментарии и ДокументацияIDE | РэдЛайн, создание сайта, заказать сайт, разработка сайтов, реклама в Интернете, продвижение, маркетинговые исследования, дизайн студия, веб дизайн, раскрутка сайта, создать сайт компании, сделать сайт, создание сайтов, изготовление сайта, обслуживание сайтов, изготовление сайтов, заказать интернет сайт, создать сайт, изготовить сайт, разработка сайта, web студия, создание веб сайта, поддержка сайта, сайт на заказ, сопровождение сайта, дизайн сайта, сайт под ключ, заказ сайта, реклама сайта, хостинг, регистрация доменов, хабаровск, краснодар, москва, комсомольск |
 
Дайджест новых статей по интернет-маркетингу на ваш email
Подписаться

Продающие сайты "под ключ"!

Наши сайты зарабытывают вам деньги. Landing-page. Эффективные продающие сайты точно в срок и под ключ! Всего от 14700 рублей
Подробнее...

Интернет-магазины и каталоги "под ключ"!

Эффективные и удобные инструменты торговли (электронной торговли) "под ключ". Продают, даже когда вы спите! Всего от 33800 рублей
Подробнее...

Комплексный интернет-маркетинг и продвижение сайтов

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

Реклама в Yandex и Google

Контекстная реклама нацелена лишь на тех пользователей, которые непосредственно заинтересованы в рекламе Ваших услуг или товаров. Всего от 8000 рублей в месяц
Подробнее...

Social media marketing (SMM) — продвижение в социальных медиа

Реклама в Однокласcниках и на Mail.ru Создание, ведение и раскрутка групп и реклама ВКонтакте и Facebook. Всего от 8000 рублей в месяц
Подробнее...

Приглашаем к сотрудничеству рекламные агентства и веб-студии!

Внимание Акция! Приглашаем к сотрудничеству рекламные агентства и различные веб-студии России! Индивидуальные и взаимовыгодные условия сотрудничества.
Подробнее...

Ускоренная разработка любого сайта от 5 дней!

Внимание Акция! Ускоренная разработка любого сайта! Ваш сайт будет готов за 5-10 дней. Вы можете заказать разработку любого сайта "под ключ" за 5-10 рабочих дней, с доплатой всего 30% от его стоимости!
Подробнее...

Ждем новых друзей!

Внимание Акция! Ждем новых друзей! Скидка 10% на услуги по созданию и(или) обслуживанию вашего сайта при переходе к нам от другого разработчика.
Подробнее...

Приведи друга и получи скидку!

Внимание Акция! Приведи друга и получи скидку! Скидка 10% на услуги по созданию и(или) обслуживанию вашего сайта, если клиент заказавший наши услуги, пришел по Вашей рекомендации.
Подробнее...

1 2 3 4 5 6 7 8 9

Новые статьи и публикации



Мы создаем сайты, которые работают! Профессионально обслуживаем и продвигаем их , а также по всей России и ближнему зарубежью с 2006 года!

Качественное и объемное представление своего бизнеса в Сети требуется любой растущей коммерческой структуре, стремящейся увеличить продажи, именно по этой причине среди наших клиентов как крупные так и небольшие компании во многих городах России и ближнего зарубежья.
Как мы работаем

Заявка
Позвоните или оставьте заявку на сайте.


Консультация
Обсуждаем что именно Вам нужно и помогаем определить как это лучше сделать!


Договор
Заключаем договор на оказание услуг, в котором прописаны условия и обязанности обеих сторон.


Выполнение работ
Непосредственно оказание требующихся услуг и работ по вашему заданию.


Поддержка
Сдача выполненых работ, последующие корректировки и поддержка при необходимости.

Остались еще вопросы? Просто позвоните и задайте их специалистам
с 2:30 до 11:30 по Мск, звонок бесплатный
Или напишите нам в WhatsApp
с 9:30 до 18:30 по Хабаровску
Или напишите нам в WhatsApp
Веб-студия и агентство комплексного интернет-маркетинга «РЭДЛАЙН» © 2006 - 2024

Профессиональная Веб-разработка. Создание сайтов и магазинов "под ключ" , а также по всей России и зарубежью. Продвижение и реклама. Веб-дизайн. Приложения. Сопровождение. Модернизация. Интеграции. Консалтинг. Продвижение и реклама. Комплексный Интернет-маркетинг.

Оставьте заявку / Задайте вопрос

Нажимая на кнопку ОТПРАВИТЬ, я даю согласие на обработку персональных данных
×

Заказать услугу

Нажимая на кнопку ОТПРАВИТЬ, я даю согласие на обработку персональных данных
×

Обратный звонок

Нажимая на кнопку ОТПРАВИТЬ, я даю согласие на обработку персональных данных
×

Подписка на дайджест новостей

Нажимая на кнопку ОТПРАВИТЬ, я даю согласие на обработку персональных данных
×

Заказать услуги со скидкой \ Бесплатная консультация







КАКИЕ УСЛУГИ ВАС ИНТЕРЕСУЮТ?

КАКИЕ ДОПОЛНИТЕЛЬНЫЕ УСЛУГИ ПОТРЕБУЮТСЯ?

Нажимая на кнопку ОТПРАВИТЬ, я даю согласие на обработку персональных данных
×

Высококачественные сайты по доступным ценамМы создаем практически любые сайты от продающих страниц до сложных, высоконагруженных и нестандартных веб приложений! Наши сайты это надежные маркетинговые инструменты для успеха Вашего бизнеса и увеличения вашей прибыли! Мы делаем красивые и максимально эффектные сайты по доступным ценам уже много лет!

Что нужно сделать, чтобы заказать создание сайта у нас?

Ну для начала вам нужно представлять (хотя бы в общих чертах), что вы хотите получить от сайта и возможно каким вы хотите его видеть. А дальше все просто. Позвоните нам или оставьте заявку нашим менеджерам, чтобы они связались с Вами, проконсультировали и помогли определиться с подходящим именно Вам сайтом по цене, сроку, дизайну или функционалу. Если вы все ещё не уверены, какой сайт вам нужен, просто обратитесь к нам! Мы вместе проанализируем вашу ситуацию и определим максимально эффективный для вас вариант.

Быстрый заказ \ Консультация

Для всех тарифных планов на создание и размещение сайтов включено:

Комплексная раскрутка сайтов и продвижение сайта Комплексный подход это не просто продвижение сайта, это целый комплекс мероприятий, который определяется целями и задачами поставленными перед сайтом и организацией, которая за этим стоит. Время однобоких методов в продвижении сайтов уже прошло, конкуренция слишком высока, чтобы была возможность расслабиться и получать \ удерживать клиентов из Интернета, просто сделав сайт и не занимаясь им...

Комплексная раскрутка работает в рамках стратегии развития вашего бизнеса в сети и направлена

Быстрый заказ \ Консультация

ЭФФЕКТИВНОЕ СОПРОВОЖДЕНИЕ (ПОДДЕРЖКА, ОБСЛУЖИВАНИЕ) САЙТОВ

Полный комплекс услуг по сопровождению сайтаМы оказываем полный комплекс услуг по сопровождению сайта: информационному и техническому обслуживанию и развитию Интернет сайтов.

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

Наша компания осуществляет техническую и информационную поддержку уже имеющихся сайтов. В понятие «поддержка сайтов» также входят услуги администрирования сайтов, обновления сайтов и их модернизация.

Быстрый заказ \ Консультация

Редизайн сайта и Адаптивный веб дизайн

Современный, технологичный, кроссбраузерный ... Профессиональный дизайн сайтов и веб-приложений

Редизайн сайта — создание нового дизайна сайта с целью улучшения внешнего вида, функциональности и удобства использования. Редизайн сайта – это способ преобразовать проект к извлечению из него максимальной отдачи и средств. В современном мире задачами редизайна является поднятие существующего сайта на новый уровень для внедрения новых технологий, при этом сохраняя многолетний сформировавшийся опыт и успешные решения компаний.

Адаптивный дизайн сайтов и веб-приложений

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

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

Быстрый заказ \ Консультация

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

Реклама в поисковых системах Яндекс и Google. Профессиональная настройка рекламы и отслеживание эффективности!

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

Быстрый заказ \ Консультация

Скидка

1500 руб.
Заинтересовались услугами создания, обслуживания или продвижения вашей компании в Интернете?!
Получите 1500 руб.
за он-лайн заявку
Предложение ограничено.

После получения заявки с Вами свяжутся наши специалисты и уточнят все детали по интересующей вас услуге.
«Нажимая на кнопку "Получить скидку", я даю согласие на обработку персональных данных»
×
Получите 1500 рублей!
×
×