Заповеди хорошего программиста

Мы попытались собрать в которой заметке все самые популярные ошибки и недочеты в оформлении/процессе/идеологии вашего программирования.

Вначале планируй, потом пиши

Лучше не пытаться сразу написать программу "с чистого листа". Используйте карандаш и бумагу, они ваши лучшие друзья.

Для написания программ лучше всего использовать "блок-схемы", знакомые еще со школы (упростить блок-схемы вам ни кто не запрещает), а так же UML.

Давай имя переменным на английском языке, русский для комментариев

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

Ах да, переменные желательно должны иметь смысловое значение. (Пример: input_file, people_count) Счетчики принято обозначать одним символом и использовать следующие символы: i, j, k.

Не используй магические цифры

Если посреди кода вы встретили одиноко стоящую цифру, которая выполняет только крайне узкую задачу, к примеру, служит «потолком» цикла (for i:=1 to 100), то вы встретили магическое число (англ. Magic number).

Выносите константы за пределы «боевых действий», тем более что в почти каждом языке программирования есть тип const (в const не имеет смысла выносить числа 0 и 1).

Структурируй свой код

Используй пробелы (или tab=4 пробела) для формирования так называемой лесенки из вложенных элементов. Таким образом, каждый следующий вложенный элемент должен быть на 1 tab правее, чем код, который на уровень меньше вложен.

Этот принцип используется в Python, как правило, программирования:

Используй комментарии

Комментарии – своеобразные подсказки на полях, которые позволят вам (через полгода или ранее), либо другому программисту, разобраться с вашим кодом. Не стоит использовать их слишком часто, но и не использовать вовсе – преступление не меньшее. (Совет: если вы используете однострочный комментарий, то после // делайте один пробел)

Тестируй свой код

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

Полезная литература: Introducing Software Testing (перевод), Основы тестирования программного обеспечения (автор профессор СПбГТУ)

Используй нотацию!!!

Без нотации мы стадо было кодеров, однако имея стандарт – наш код становится лучше и понятнее, а как следствие – программы становятся более надежными (число ошибок уменьшается). Существует множество нотаций, на мой взгляд, одна из лучших – нотация от RSDN (она написана для C#, однако она хорошо подойдет и для других языков программирования). [скачать pdf]

↑ Расскажите друзьям о статье


Comments system Cackle

© EduNow.su — материалы подлежат полному/частичному копированию при указании прямой ссылки на источник. (Сегодня 19.10.17)