Пробелы

Пропуск строк

Оглавления

Пояснительные комментарии

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

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

Существенно содержание комментариев. Нет необходимости переводить с английского каждый оператор программы. Комментарии должны объяснять цель группы операторов программы, а не перефразировать программу.

/* ПРОВЕРИТЬ, ЯВЛЯЕТСЯ ЛИ ВЕЛИЧИНА ОТРИЦАТЕЛЬНОЙ */

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

/* ВЫПОЛНИТЬ ОБРАБОТКУ ОТРИЦАТЕЛЬНОГО САЛЬДО (СУММАРНЫЕ РАСХОДЫ ПРЕВЫШАЮТ ДОХОДЫ.) */

Комментарии должны указывать цель действия или объяснять логику программы.

Рекомендуется располагать комментарии на одинаковом уровне, например, начинают комментарии с 50-й позиции. Перед строкой комментариев желательно пропускать пустую строку.

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

Если программа очень большая, то целесообразно использовать оглавление. Оглавление размещается в начале главного модуля программы и должно содержать название, размещение и функцию каждого программного модуля.

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

В языках программирования пробелы довольно часто ставятся произвольно. В изъятии пробелов из программы не больше смысла, чем в том, чтобы их убрать из текста. Что вы скажете, например, о такой фразе: "Явсегдамогунаписатьнечтоподобное,высможетепрочестьно этопотребуетотвасслишкоммногоусилий".

Пробелы следует ставить везде, где это приводит к улучшению читаемости программы.

Можно написать такой оператор:

for(i=1;i<=10;i++)

Но написанный ниже оператор читать значительно легче:

for (i=1; i<=10; i++)

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

1 + А*В

предпочтительнее, чем вводящее в заблуждение выражение

1+А * В

Дата добавления: 2014-01-05