Рекомендации по составлению программ

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

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

Универсальная программа должна обрабатывать вырожденные случаи (например, число элементов вектора равно 0 или 1) и печатать сообщение об ошибке, если размер массива превысил допустимое значение (использованное в описании массива).

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

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

3. Некоторые простые приемы позволяют повысить эффективность программы (т. е. уменьшить количество выполняемых операций и, как правило, время работы программы). К таким приемам относятся:

- использование операции умножения вместо возведения в степень для низких степеней, например Х*Х*Х вместо X**3(выполняется быстрее);

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

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

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

При написании программы следует заботиться о ее структуре так, чтобы программа была удобочитаемой. В частности, в программе должны быть хорошо видны циклы. Если возможно, нужно стремиться для организации циклов использовать оператор FOR... TO..., заканчивая цикл оператором NEXT.

5. Тестирование и отладка - это проверка правильности работы программы и исправление обнаруженных ошибок.

Если программа транслируется первый раз, то вычислительной машиной выводится список обнаруженных ошибок. Однако полностью доверять машине на этом этапе не следует. Она анализирует программу формально, с точки зрения соответствия операторов правилам языка. Некоторые ошибки не могут быть ею выявлены (если используется, например, A+В вместо А-В), другие ошибки воспринимаются неадекватно. Возможны также наведенные ошибки, являющиеся следствием других ошибок.

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

Тест - это специально подобранные исходные данные в совокупности с теми результатами, которые должна выдавать программа при обработке этих данных. Разработка тестов трудоемкая работа, часто требующая ручных просчетов. Можно конструировать тесты, исходя из желаемого результата, т. е. применяя обратный ход. Например, чтобы получить уравнение, имеющее на заданном отрезке один корень, можно выбрать произвольное число а и умножить (х-а) на любую функцию, заведомо не имеющую корней на рассматриваемом отрезке (например, sin(х+0,5)). При составлении тестов нужно стремиться обеспечить проверку всех ветвей программы. Несовпадение результатов программы с результатами тестов - признак наличия ошибок. Чтобы локализовать ошибки, в программу вставляют отладочную печать — печать промежуточных результатов, что позволяет проследить за ходом выполнения программы. После окончания отладки отладочные печати должны быть удалены.

6. Составление документации. Если программа предназначена для длительной эксплуатации, то по ней необходимо иметь полную документацию. Особенно необходима документация, если программа эксплуатируется не ее автором. Пока программа просто эксплуатируется, достаточно иметь инструкцию по ее использованию. Если же ее необходимо модернизировать или в ней обнаружена ошибка, то нужна полная документация. Формальные требования к документации программ описаны в ЕСПД (ЕСПД - Единая Система Программной Документации - серия ГОСТов, описывающая правила по составлению документации к программам). Здесь кратко остановимся на составе документации и некоторых приемах ее составления.