Exponenta Banner
exponenta event banner

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

Рекомендации по субидентификатору

  • NA-MAAB - a

  • JMAAB - не поддерживается

Версии MATLAB

Все

Правило

Sub ID a

Функциональный блок MATLAB должен иметь описательный заголовок.

Информация в заголовке может включать, но не ограничиваться:

  • Имя функции

  • Описание функции

  • Допущения и ограничения

  • Описание изменений предыдущих версий

  • Перечни входов и выходов

Пользовательский параметр

Неприменимо

Пример
%% Function Name: NA_0025_Example_Header
%
% Description: An example of a header file
%
% Assumptions: None
%
% Inputs:
%     List of input arguments
%
% $Revision: R2020a$ 
% $Author: MathWorks Advisory Board (MAB)$
% $Date: November 20, 2019$
%---------------------------------------------------------

Объяснение

Субидентификатор a:

  • Улучшает удобочитаемость, моделирование модели, тестопригодность и рабочий процесс.

  • Создание кода может оказаться невозможным.

Проверка

Соблюдение этого руководства по моделированию невозможно проверить с помощью проверки Model Advisor.

Последнее изменение

R2020a

Представлен в R2020a

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

Поддержка