Спецификация программного файла или модуля (документирование программ)

Спецификация программного файла или модуля (документирование программ)

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

· идентификация проекта, к которому принадлежит файл;

· назначение (название) и имя файла;

· версия файла; фамилия автора(ов);

· описание модуля;

· история изменений модуля.

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

Соглашения по читаемости программ

Лесенка

"Лесенка" должна отражать структурную вложенность языковых конструкций. Рекомендуется отступ не менее  2-х и не более 8-и пробелов. Принятого отступа нужно придерживаться во всем тексте программы. Правила написания некоторых конструкций:

if ( <условие> )

<операторы>

else

<операторы>

end

 

while ( <условие> )

<операторы>

end

 

for индекс = начальное_значение : шаг : конечное_значение

операторы_тела_цикла;

end

 

switch ( <выражение> )

case <выражение>:

<операторы>;

........

otherwise

<операторы>;

end

Длина строк программного текста

 

Длина строк программы не должна превышать ширины экрана (80 символов).

 

Прочие рекомендации

 

А. Рекомендуется  операнды  бинарных  операций  (+,  =  и  т.п.)  отделять  от  знака операции одним пробелом " ".

Например:

Sum = A + B;

 

Б.  Рекомендуется при перечислении идентификаторов после запятой "," ставить один пробел " ".

Например:

fprintf( ‘Сумма: %d; Разность: %d.’, A + B, A – B );

 

В.  Рекомендуется 16-ричные числа писать большими буквами.

 

Отладка

 

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

Отладка программы происходит с использованием особого инструмента -- отладчика (debuger). В MATLAB удобно работать с отладчиком через графический интерфейс.

Чтобы начать отладку необходимо запустить программу на выполнение. Для запуска программы можно использовать кнопку «Run» во вкладке меню «Editor». При запуске программы произойдет ее автоматическое сохранение. Файл с текстом программы должен быть предварительно сохранен на диске для того, чтобы иметь возможность запускать и отлаживать программу.

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

Точки останова помещаются на определенную строку кода щелчком мыши по пространству справа от номера строки.

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

· выполнять до следующей точки останова, если такая есть, а если нет – то отладчик продолжит свою работу до самого окончания программы;

· выполнять программу пошагово;

· выполнять до позиции курсора.

Команды управления отладкой находятся в секции «debug».

Каждая команда может быть доступна по горячим клавишам:

Таблица 1. Горячие клавиши режим отладки

Команда

Клавиша

Запуск программы (продолжить выполнение)

F5

Вычислить выделенное выражение и вывести результат в командное окно

F9

Выполнить одну команду (шаг)

F10

Шаг с заходом

F11

Шаг с выходом

F11

 

Шагом является выполнение инструкции(ий), находящих на текущей строке, обозримой отладчиком. Текущая строка обозначается зеленой стрелкой слева от поля редактирования программы.

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

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

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