Семь советов по написанию чистого кода

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

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

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

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

Continue reading