Стиль программирования.

[pol@nder]

Сегодня нашел очень полезную информацию, хочу поделиться ею с Вами. Сразу скажу - в интернете этого не найдете, это выжимки из различной литературы. Распространяются эти неписанные правила на все языки программирования, будь то pawn, c, java, delphi, не важно.
Если Вы хотите стать хорошим программистом, этот урок будет чрезвычайно полезен для Вас.

Всего планирую сделать 3 подобных урока на темы: Стиль программирования, разработка программы, тестирование/отладка.

Авторство себе не присваиваю, просто информация действительно дико полезная для любого начинающего программиста, а возможно даже и для профессионала.
____


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

Программы читаются людьми.

Если есть несколько равноценных способов сделать что-либо, то остановитесь на одном и всегда его придерживайтесь.

Идентификаторы.

• Выбор идентификатора - интеллектуальный процесс.
  Мнемоника идентификаторов.
• Стандартные идентификаторы и стандартные сокращения.

Читаемость.

• Умело расставленные пробелы улучшают читаемость программы, неумело расставленные - могут ухудшить.
• Один оператор в одну строку.
• Скобки лучше, чем ошибки.
• Отступы используются для выявления структур (программ/данных).

Комментарии.

• Комментариев должно быть больше, чем кажется необходимым.
• Некомментируемая программа - грубая ошибка.
• Комментарии пишут вместе с программой.
• Вводные комментарии нужны.
• В больших программах нужно оглавление. Модули и интерфейс.
• Комментарии должны содержать дополнительную информацию, а не перефразирование программы.
• Комментарии надо располагать так, чтобы не уменьшать наглядность программы.
• Лучше не иметь комментариев, чем иметь неправильные.

Типы комментариев.

• Вводные (назначение программы, указания по вызову и применению программы, список и назначение основных переменных, указания по вводу/выводу, список используемых файлов, описание методов решения и ссылки на литературу, требования к ресурсам, сведения об авторе, время создания).
• Пояснительные комментарии.
• Оглавление.

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

*Поправьте, если есть ошибки, перепечатывал вручную.