Exponenta Banner

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

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

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

Объяснение

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

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

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

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

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

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

  • FunctionName

  • Описание

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

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

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

Пример:

% 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

Поддержка