adsPlace_1

Войти или Зарегистрироваться

adsPlace_3

Несколько советов по написанию чистого кода

Несколько советов по написанию чистого кода

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

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

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

1. Продумать логику до написания

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

2. Структура страницы

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

<div id="main-container">
    <div id="header">
        <div id="logo">...</div>
        <div id="main-menu">...</div>
    </div>
    <div id="content">
        <div id="left-column">...</div>
        <div id="center-column">...</div>
        <div id="right-column">...</div>
    </div>
    <div id="footer">
        <div id="footer-menu">...</div>
    </div>
</div>

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

3. Используйте правильные отступы

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

Несколько советов по написанию чистого кода

4. Написание комментариев

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

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

5. Избегайте злоупотреблением комментариями

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

  • Давать пояснения себе (например, / * Закончу это позже … * /);
  • Перекладывать материал на других людей (например, /* Евгений писал этот участок кода. Спросите его. */);
  • Давать расплывчатое описание (например, /* Это еще одна математическая функция. */);
  • Удалять фрагменты кода. Иногда разработчики не уверенны в стирании участка кода. Хотя я и сам этим пользуюсь, но в конечном итоге необходимо почистить весь код от данного рода комментариев.

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

Правильные примеры использования комментариев:

  • Авторские характеристики (например, /* Исправления обхода дерева вложенности от Александра, 25 февраля 2011*/);
  • Подробная информация по функциональности метода или процедуры (например, / * Эта функция проверяет авторизацию через форму с помощью функции check_mail */);
  • Мелкие уведомления об изменениях (например, /* Добавлена функция проверки почты */).

6. Избегайте очень больших функции

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

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

7. Использование правильных имен функций и переменных

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

8. Избегайте смешивания языков программирования

С использованиям CSS и JavaScript чрезвычайно нередко приходиться как раз встречаться со сценариями которые содержат в для себя все процедуры данных языков. Как бы это было не странно, но данное смешивание кода, стало быть, может привести к, как всем известно, большим дилеммам и, как все говорят, большой-большой неурядице. К примеру, я постоянно храню файлы стилей в отдельном файле, так же делаю и с JavaScript сценариями. Само-собой разумеется, даже HTML представление страничек почаще всего храню раздельно от бизнес-логики в шаблонах, благодаря паттерну MVC.

Несколько советов по написанию чистого кода

Подведем итоги

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

Последние из рубрики

Комментарии(0)

  • Комментариев еще нет. Будь первым!

    Оставь свой отзыв

    Для вставки кода используйте кнопки php, html, javascript, css, sql

    * - поля обязательны к заполнению