Почему Стиль кодирования вопросам

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

Если у вас не хватает соответствующих комментариев, или даже если вы неправильно слово или два в вашем комментарии, он будет вычитать очки.Если ваш код был “ messy” (по его меркам), он будет вычитать очки.Сообщение было ясно: качество вашего кода заключается не только в его исполнении, но и в его внешний вид.Это был мой первый опыт работы с кодировкой style.

What’ S Стиль всяком случае

Стилю, как ваш код выглядит, просто и ясно.И от “ ваша, ” Я на самом деле означает, что Вы, человек, который читает эту статью.Стиль кодирования очень личным и каждый имеет свой собственный предпочтительный стиль.Вы можете открыть свой собственный стиль, оглядываясь назад над кодом, который you’ ве написано, когда вы didn’ т есть стиль руководства придерживаться.Каждый человек имеет свой собственный стиль, потому что, как они научились код.Если вы используете интегрированную среду разработки (IDE), таких как Visual Studio, чтобы узнать кодирования, свой стиль, вероятно, совпадает с тем, насильственные редактором.Если вы узнали, с помощью простого текстового редактора, вероятно, ваш стиль эволюционировал от того, что вы думали, был более readable.

Style Guide Не только издательствам нужно стиля руководства.Если вы хотите сохранить ваш код читаемым и просты в обслуживании даже спустя годы после you’ ве выпустила веб-сайте, стилем руководства является полезным и необходимым. (Изображение кредита: Wikidave)

Вы даже можете заметить, что ваш стиль меняется от языка к языку.Решения, которые вы сделали в JavaScript, возможно, не переносятся на вашем CSS.Например, вы можете решить, наличие строки должны использовать двойные кавычки в то время как CSS строк следует использовать одинарные кавычки.Это isn’ T редкость, как мы, как правило, переключение контекста, когда мы переключаться между языками.Тем не менее, it’ S интересное упражнение в порядке самообороны observation.

Стиль кодирования состоит из множества мелких решений, основанных на языке:

  • Как и когда использовать комментарии,
  • Табуляции или пробелов для отступа (и сколько пробелов),
  • Надлежащее использование белого пространства,
  • Собственные имена переменных и функций,
  • Код группировки организации,
  • Шаблоны для использования,
  • Шаблоны быть avoided.

Это далеко не исчерпывающий список, как стиль кодированияможет быть чрезвычайно мелкозернистый, такие как Google JavaScript Стиль Guide или более общие, такие как JQuery Стиль Основной Guidelines.

It’ S Personal

Личный характер стиля кодирования является проблемой в команде атмосферу.Часто, стремясь избежать длинных рассуждений, команды отложить создание стиля руководства под видом не желая “ препятствовать инновациям и expression.” Некоторые видят в команде определенный стиль руководства, как способ заставить всех разработчиков, будет то же самое.Некоторые разработчики повстанческой при предъявлении стиль руководства, полагая, что они can’ T должным образом выполнять свою работу, если кто-то говорит им, как писать свои code.

Я сравниваю ситуацию с группой музыкантов пытаются сформировать группу.В каждом номере, полагая, что их способ делать вещи лучше (их “ method” или “ process”).Группа будет бороться, пока все пытаются делать свое дело.It’ невозможно создать хорошую музыку, если все в группе соглашается на темп, стиль и кто должен играть ведущую во время песни.Любой, кто когда-либо слышал школьной группы выполняют знает, что это правда.Если все на той же странице, вы aren’ T собирается выполнить much.

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

Связь Key

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

— Г. Г. Абельсон и Суссман (в “ Структура и интерпретация компьютерных Programs”)

Самое главное при работе в команде, это общение.Люди должны быть в состоянии эффективно работать вместе, и единственный способ сделать это путем передачи.Как разработчики, мы общаемся в основном через код.Мы общаемся с другими частями программного обеспечения через код и мы общаемся с другими разработчиками через code.

Во время работы программного кода общается с doesn’ T безразлично, как выглядит код, другой в вашей команде, конечно, сделать.Как выглядит код добавляет к нашему пониманию.Сколько раз вы открыли кусок кода, что кто-то другой написал, и, прежде чем делать что-либо еще, повторно отступом это так, как вы хотели?That’ S ваш мозг не в состоянии разобраться в коде, потому что, как он выглядит.Когда все написания кода, который выглядит по-другому, все постоянно пытается визуально анализировать код, прежде чем быть в состоянии понимать это.Когда все написания кода, который выглядит так же, ваш мозг может немного расслабиться, как приходит понимание faster.

BBC GEL Не только дизайнеры могут использовать стиль руководства для обеспечения последовательного визуального дизайна и обоснованные проектные решения (как в BBC’ S GEL пример выше).Мы могли бы использовать их на макроуровне, а также: для маленьких мелких деталей в нашем code.

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

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

Оставить себе Clues

“ Если вы знаете врага и знаете себя, вы не будете опасности в сотню battles.”

— Сунь-цзы (в “ Искусство War”)

Зная себя важно в жизни, а также кодирование.Тем не менее, you’ больше никогда сами знаете достаточно хорошо, чтобы точно вспомнить, что вы думали, когда писали каждой строки кода.Большинство разработчиков испытал, глядя на очень старый кусок кода, который они писали и не имея ни малейшего представления, почему они написали.It’ не то, что ваша память плохая, it’ просто, что вы делаете так много этих маленьких решений при написании кода, который it’ невозможное, чтобы следить за ними all.

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

Если вы хотите прочитать полностью статью, посетите сайт наших спонсоров

Comments are closed.