[Smartscribo] Fwd: [Manager] Стиль кодирования

[dkorzun]

FYI.

Корзун Дмитрий Жоржевич, к.ф.-м.н., доцент
Петрозаводский государственный университет, математический факультет, 
Кафедра информатики и математического обеспечения (www.cs.karelia.ru) 
Адрес: 185910, Республика Карелия, г. Петрозаводск, пр. Ленина, 33
Каб.: 217,  E-mail: dkorzun at cs.karelia.ru,
тел.: +7 (8142) 711084, +7 (8142) 711015,  факс: +7 (8142) 711000



-------- Original Message --------
Subject: [Manager] Стиль кодирования
Date: Sun, 16 Oct 2011 21:40:02 +0400 (MSK)
From: "Iurii A. Bogoiavlenskii" <ybgv at cs.karelia.ru>
To: manager at cs.karelia.ru


 	Коллеги, отправьте это письмо Вашим разработчикам.

 	1. Про "магические числа":

http://ru.wikipedia.org/wiki/%D0%A1%D1%82%D0%B0%D0%BD%D0%B4%D0%B0%D1%80%D1%82_%D0%BE%D1%84%D0%BE%D1%80%D0%BC%D0%BB%D0%B5%D0%BD%D0%B8%D1%8F_%D0%BA%D0%BE%D0%B4%D0%B0

 	2. Про стиль коирования. Нижеследущие цитаты из:

http://ru.wikipedia.org/wiki/%D0%A1%D1%82%D0%B0%D0%BD%D0%B4%D0%B0%D1%80%D1%82_%D0%BE%D1%84%D0%BE%D1%80%D0%BC%D0%BB%D0%B5%D0%BD%D0%B8%D1%8F_%D0%BA%D0%BE%D0%B4%D0%B0

 	им необходимо выучить наизусть и применять всегда!

 	ЮА

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

обеспечения.

Целью принятия и использования стандарта является упрощение восприятия 
программного кода человеком, минимизация нагрузки на память и зрение при 
чтении программы.

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

Большинство специалистов сходятся во мнении, что комментарии должны 
объяснять намерения программиста, а не код; то, что можно выразить на 
языке программирования, не должно выноситься в комментарии — в частности, 
надо использовать говорящие названия переменных, функций, классов, методов

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