Вы когда-нибудь работали над проектом со своими друзьями и понимали, что код ваших друзей трудно читать, потому что его переменная именования непоследовательна или, может быть, иногда между = есть пробелы, а иногда они не используют ее? Или, может быть, вы слишком великодушны и с нетерпением ждете возможности внести свой вклад в проект с открытым исходным кодом на GitHub, и обнаруживаете, что ваш запрос на вытягивание был закрыт из-за вашего стиля кода? Тогда вы попали в нужное место. Сегодня я собираюсь дать советы о том, как поддерживать хороший код, который легче читать как вам самим, так и другим людям.

Что такое стиль кода?

Стиль кода, стиль программирования или соглашения о кодировании - это набор правил или рекомендаций при написании кода. Мотивация создания стиля кода - убедиться, что разработчики пишут на основе руководства, чтобы его могли прочитать другие разработчики. Кроме того, это также помогает избежать ошибок разработчиков при написании кода. Большинство языков программирования имеют более одного стиля кода. Это произошло из-за того, что компании или организации с открытым исходным кодом обычно имеют свой собственный стиль кода. Одно из странных соглашений об именах, которые я когда-либо обнаруживал, - это стиль исходного кода Android, в котором я должен написать дополнительный m перед переменной имени для некоторых определенных типов переменных. Я с трудом принимаю это соглашение, я соблюдаю это соглашение только тогда, когда преподаю на семинарах (я такой плохой разработчик!).

Где я могу изучить стиль кода для определенного языка программирования?

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

Вот несколько доступных стилей кода.

1. Python



PEP 8 - Руководство по стилю кода Python
Официальный сайт языка программирования Python www.python.org





Руководство по стилю Google Python
Исключения Глобальные переменные Вложенные / Локальные / Внутренние классы и Функции Составление списка Итераторы по умолчанию и… google.github.io



2. PHP



php-fig / fig-стандарты
fig-standard - стандарты, предложенные или одобренные Framework Interop Group github.com





Manual :: Coding Standards
Перенаправлен сюда со страницы« Добавить патч с утверждением« Убедитесь, что ваш стиль кодирования соответствует Coding… pear.php. сеть"



3. Javascript



airbnb / javascript
javascript - Руководство по стилю JavaScript github.com





Стиль кода
Этот документ пытается объяснить основные стили и шаблоны, которые используются в базе кода Mozilla. Новый код должен… developer.mozilla.org



И есть еще много других стилей кода. Как мы видим, некоторые организации, такие как та, что стоит за Python, уже создают стиль кода под названием PEP 8, однако внезапно Google также выпустил свой собственный (он может быть основан на PEP 8, я не уверен, но я уверен, что у них есть различия). Это касается и разных языков программирования!

Какой использовать?

Это действительно зависит от того, над каким проектом вы работаете. Если вы работаете над своим личным командным проектом в университете или просто в собственном стартапе, вы действительно можете использовать любой из них или даже создать свой собственный. Но даже если это ваш собственный стартап, я предлагаю вам следовать некоторым доступным стилям кода. Почему? Поскольку я думаю, что для каждого правила в стиле кода есть причина, это может сделать ваш код более читабельным для вашего партнера. Да, вы можете немного изменить, но я все же настоятельно рекомендую вам создать свой собственный стиль на основе доступного стиля кода. Если вы работаете над проектом с открытым исходным кодом, например тем, что доступно на GitHub, обычно они уже создают раздел для стиля кода (либо в README.md, либо в CONTRIBUTING.md ), которые они используют в проекте GitHub, убедитесь, что вы соблюдаете эти правила, иначе ваш запрос на перенос может быть закрыт. Что, если мы работаем над нашим личным проектом? Я по-прежнему предлагаю вам соответствовать любому популярному стилю кода, по крайней мере, вы привыкнете к использованию этого стиля кода.

Заключительные слова

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