na_0025: Заголовок функции MATLAB

ID: Заголовок

na_0025: MATLAB^® Function Header

Приоритет

Строго рекомендуемый

Осциллограф

NA-MAAB

Версии MATLAB

Все

Предпосылки

'none'

Описание

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

FunctionName
Описание функции
Предположения и ограничения
Описание изменений от предыдущих версий
Списки вводов и выводов

Пример:

%% Function Name: NA_0025_Example_Header
%
% Assumptions: None
%
% Inputs:
%   List of input arguments
%
% Outputs:
%   List of output arguments

%
% $Date: August 27, 2012
% ________________________________________

Объяснение

Удобочитаемость
Верификация и валидация
Рабочий процесс
Генерация кода

Смотрите также

Инструкция jh_0073 по стилю НАСА Orion: Заголовок EML

В последний раз измененный

V3.0

Проверка Model Advisor

Не применяется

Введенный в R2013a

Поддержка

Памятка переводчика

1. Если смысл перевода понятен, то лучше оставьте как есть и не придирайтесь к словам, синонимам и тому подобному. О вкусах не спорим.

2. Не дополняйте перевод комментариями “от себя”. В исправлении не должно появляться дополнительных смыслов и комментариев, отсутствующих в оригинале. Такие правки не получится интегрировать в алгоритме автоматического перевода.

3. Сохраняйте структуру оригинального текста - например, не разбивайте одно предложение на два.

4. Не имеет смысла однотипное исправление перевода какого-то термина во всех предложениях. Исправляйте только в одном месте. Когда Вашу правку одобрят, это исправление будет алгоритмически распространено и на другие части документации.

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

Документация