Хороший стиль программирования

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

1. Не забывайте о комментариях

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

Комментарии - важнейший элемент стиля, это очень мощный инструмент, позволяющий сделать программу действительно понятной.

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

Комментируйте описания переменных

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

Примеры плохих комментариев: "счетчик", "дополнительная переменная", "вещественное число", "строка".

Примеры хороших комментариев: "количество найденных совпадений", " самое большое число в списке", "строка, подготовленная для печати"

Комментируйте логику программы

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

Важно понимать, что комментировать надо в первую очередь сложно не программисткую, а содержательную суть выполнения действий, иначе комментарий становиться просто мусором, который не помогает, а мешает восприятию программ.

Вот типичный фрагмент из программы на Паскале:

k:=k+1; {увеличим k на 1}

Комментарий здесь абсолютно ничего не прибавляет к тексту программы: читатель и так видит, что k увеличивается на 1 (а если не видит, то ему не поможет даже самый подробный комментарий). Здесь был бы полезен комментарий, поясняющий, почему происходит это увеличение. Например, "нашли очередное совпадение" или "переходим к следующему элементу".

2. Понимание переменных - ключ к пониманию программы

Любая программа обрабатывает какую-то информацию. Эта информация представляется в программе в виде переменных (массивы и другие составные типы данных - это просто специальные виды переменных). Следовательно,  для понимания программы необходимо в первую очередь понять смысл переменных, которые в ней используются.

Все переменные должны быть описаны

Для некоторых языков программирования этот совет избыточен.

Паскаль, Си заставляет описывать переменные - иначе программа считается синтаксически неверной.

А вот Бейсик и некоторые другие языки представляют программисту больше свободы: переменные можно и не описывать, их использование подразумевает автоматическое описание, а тип и другие необходимые данные определяются из контекста.

Но это очень обманчивая свобода.

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

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