Skip to content

Instantly share code, notes, and snippets.

Embed
What would you like to do?

Как отформатировать код

Код должен выглядеть аккуратно и оформляться не как попало, а как принято. Почему? Ну потому, что другой человек, который будет смотреть твой код, вряд ли обрадуется, когда ему придется разбирать слипшиеся строчки, разбросанные в беспорядке скобки и написанные русскими словами названия переменных. Особенно плохо будет если это, например, код тестового задания, которое ты сделал, чтобы устроиться на работу. Если он будет неряшливым, это будет большой минус.

Не бойся, сделать код аккуратным совсем не сложно. Самый универсальный способ — вставить его на сайт http://phpformatter.com и нажать кнопку Format. Робот сам выровняет твой код в лучших традициях.

Если ты используешь для редактирования кода IDE, то все еще проще (а если не используешь, то почему бы не начать?):

  • Eclipse PDT — жми Ctrl + Shift + F для автоматического форматирования кода.
  • Netbeans for PHP — жми Alt+Shift+F
  • Zend Studio — жми Ctrl + A (выделить все), затем Ctrl + Shift + F
  • PhpStorm — жми Ctrl+Alt+L
  • PHPDesigner — поищи нужную опцию в меню, она там есть. Или жми Ctrl + Shift + F1
  • Komodo IDE — правая кнопка -> Format Using...

Вот так, нажатием одной кнопки ты можешь сделать жизнь гораздо проще.

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

Если ты используешь Sublime Text 3, ставь расширение https://github.com/akalongman/sublimetext-codeformatter , но с ним придется повозиться, устанавливая и настраивая нужные компоненты, подойдет только для опытных пользователей.

Основные правила

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

  • переменные и функции пишутся с маленькой буквы, подчеркивание не используется, используется camelCase, пример: $x, $numberOfPeople, printResults()

  • название функции начинается с глагола, в стиле «сделайЧтоТо»

  • не знаешь английский (неужели такое бывает?) Не беда, в 21 веке есть решение этой проблемы. Не пиши транслитом, открой лучше Гугл Транслейт или slovari.yandex.ru и найди название для переменной там

  • в именах классов используется CamelCase, первая буква большая, «_» может использоваться

  • мы предпочитаем подстановку переменных вместо конкатенации строк: "I am $age years old" — хорошо, 'I am ' . $age . ' years old' — плохо

  • мы используем для отступов 4 пробела, а не табы (нужно настроить редактор, чтобы при нажатии Tab он вставлял 4 пробела)

  • скобки в for и if/else ставятся так (египетские скобки):

      if (...) {
          // ... 
      } else {
          // ...
      }        
      for (...) {
          // .....
      }
    
  • у определений функций и классов так:

      function makeMeFeelGood(...)
      {
          // ...
      }
    
@RobertWagner232

This comment has been minimized.

Copy link

RobertWagner232 commented Jul 15, 2018

ty

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.