na_0025: MATLAB Function header

Рекомендации по идентификатору подраздела

  • NA-MAAB - a

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

Версии MATLAB

Все

Правило

Идентификатор подраздела a

Блок MATLAB Function должен иметь описательный заголовок.

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

  • Имя функции

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

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

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

  • Списки входов и выходов

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

Неприменимо

Пример
%% 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

Поддержка

Для просмотра документации необходимо авторизоваться на сайте