Код для компьютеров или для людей? [закрыто]

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

- от "Структуры и Интерпретации Компьютерных программ" Abelson и Sussman

Да.

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

Недостающий объект: комментарии.

, Даже если код является совершенно четким своему автору, это не могло бы быть для всех.

мое взятие на этом - то, что все относительно.

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

, Если код функционален, он имеет потенциал того, чтобы быть считанным.

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

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

, Но в конечном счете, код, чтобы быть превращенным в ряд инструкций к машине.

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

Компилятор не заботится, написан ли Ваш код чисто или нечитабельная путаница - пока синтаксис правилен, код скомпилирует, и это будет работать.

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

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

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

Запись для людей, не машина.

Roedy Green записал обширному названному руководству: Неудобный в сопровождении Код .

, "Имея это в виду, что этот программист может сделать для создания кода более легко прочитанным людьми?"

Ответ: Прочитайте это руководство и примените реверс всего, что он говорит Вашим опытно-конструкторским разработкам.

Кавычка от раздела общих принципов:

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

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

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

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

, В то время как это твердо язык в щеке, это - на самом деле очень полезный список (кроме неприятной рекламы) того, что избежать, если Вы на самом деле заботитесь о записи читаемого / удобный в сопровождении код.

<sarcasm> Код только должен быть прочитан машиной. Пока конечный результат fulfulls потребность пользователя, не имеет значения, на что похож код. </sarcasm>

Теперь удобный в сопровождении код или код, который может измениться, это - совершенно другая история.

Вы создали бы дом с планом, набросанным в конце салфетки, или выбросили бы проекты после того, как Вы сделаны, создав дом, Вы могли бы хотеть добавить комнату на один день?

Не используйте венгерская запись на безопасном с точки зрения типов языке.

Я бы порекомендовал взглянуть на Чистый код Роберта Мартина. Это отличное руководство о том, как сделать ваш код более читабельным и чистым.

Я отношусь к этому несколько косвенно - речь идет не о удобочитаемости, а о ремонтопригодности.

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

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

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

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