Требования к оформлению программ на языке matlab

↑

▷ Содержание

Стр 1 из 3Следующая ⇒

Приложение 2

Требования к оформлению программ на языке MATLAB

Cоглашение по именованию идентификаторов

Подбор идентификаторов

А. Все идентификаторы должны выбираться из  соображений читаемости  и максимальной семантической нагрузки.

Например:

dx = 0.001;      % шаг интегрирования

Area = a*b;       % Площадь прямоугольника

Неудачными можно считать идентификаторы: UU qq = 0.0001;  % шаг интегрирования

kk = a*b;       % Площадь прямоугольника

Б.  Идентификаторы рекомендуется подбирать из слов английского языка. Например:

% размеры изделия (ширина, высота)

Height=3;

Не очень удачными можно считать идентификаторы:

% размеры изделия (ширина, высота)

Shirina=4; Vysota=3;

Написание идентификаторов

Существует два основных способа написания идентификаторов.

А. В  любых  идентификаторах  каждое  слово,  входящее  в  идентификатор,  писать, начиная с большой буквы, остальные буквы – маленькие.

Например:

NextX, LastX, GraphErrorMsg

Б. В любых идентификаторах каждое слово, входящее в идентификатор, разделять символом "_" , при этом все буквы – маленькие.

Например:

next_x, last_x, graph_error_msg

Соглашения по самодокументируемости программ

Комментарии

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

Б. Для указания начала комментария в MATLAB используется символ «%».

% программа, вычисляющая гипотенузу прямоугольного треугольника

% a, b - катеты прямоугольного треугольника

% с - вычисляемая гипотенуза

% промежуточные расчеты

x = a^2 + b^2;

% вычисляем гипотенузу

c = sqrt(x);

Познавательные статьи:



Формы дистанционного обучения

Передача мяча двумя руками снизу

Значение правильной осанки для жизнедеятельности человека

Основные ошибки при выполнении передач мяча на месте