Exponenta Banner

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

Введенный в R2013a

Была ли эта тема полезной?
Документация Simulink
Поддержка