Руководство по написанию кода

Этот сайт предназначен для веб-разработчиков и программистов компании HANDS.CENTER и является кратким сводом правил и инструкций, принятых при доработке и разработке проектов. Их задача — помочь программистам унифицировать решения некоторых задач.

Качество программы начинается с качества ее исходного кода. Основным фактором качества исходного кода программы является его читаемость и понятность.

Правила форматирования кода должны быть едиными во всем проекте. И крайне желательно, чтобы они были очень похожими между проектами.

Согласованность с этими руководством очень важна. Согласованность внутри одного проекта еще важнее. А согласованность внутри модуля или функции — самое важное. Но важно помнить, что иногда это руководство неприменимо, и понимать, когда можно отойти от рекомендаций. Когда вы сомневаетесь, просто посмотрите на другие примеры и решите, какой выглядит лучше.

Две причины для того, чтобы нарушить данные правила:

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