Exponenta Banner

himl_0001: Использование стандартизированных заголовков функций MATLAB

Идентификатор: Заголовокhiml_0001: Использование стандартизированного MATLAB® заголовки функций
Описание

При использовании функций MATLAB используйте стандартизированный заголовок, чтобы предоставить информацию о назначении и использовании функции.

Объяснение

Стандартизированный заголовок улучшает читаемость и документирование функций MATLAB. Заголовок должен содержать описание функции и информацию об использовании.

Проверки Model AdvisorПроверяйте использование стандартных заголовков функций MATLAB (Simulink Check)
Ссылки

  • DO-331, раздел MB.6.3.4.e - Исходный код прослеживается до низкоуровневых требований

  • ISO 26262-6, Таблица 1 (1g) - Использование стилевых руководств

См. также
Последнее изменениеR2018b
Примеры

Типичный стандартизированный заголовок функции включает в себя:

  • Имя функции

  • Описание

  • Входы и выходы (по возможности включают размер и тип)

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

  • История ревизий

Пример:

% FUNCTION NAME:
%   avg
%
% DESCRIPTION:
%   Compute the average of three inputs
%
% INPUT:
%   in1 - (double) Input one
%   in2 - (double) Input two
%   in3 - (double) Input three
%
% OUTPUT:
%   out - (double) Calculated average of the three inputs
%
% ASSUMPTIONS AND LIMITATIONS:
%   None
%
% REVISION HISTORY:
%   05/02/2018 - mmyers
%       * Initial implementation
%

Документация по IEC Certification Kit

Поддержка