This is machine translation

Translated by Microsoft
Mouseover text to see original. Click the button below to return to the English version of the page.

Note: This page has been translated by MathWorks. Click here to see
To view all translated materials including this page, select Country from the country navigator on the bottom of this page.

na_0025: MATLAB Function Header

ID: Title

na_0025: MATLAB® Function Header

Priority

Strongly recommended

Scope

NA-MAAB

MATLAB Versions

All

Prerequisites

None

Description

MATLAB Functions must have a descriptive header. Header content may include, but is not limited to, the following types of information:

  • Function name

  • Description of function

  • Assumptions and limitations

  • Description of changes from previous versions

  • Lists of inputs and outputs

Example:

%% Function Name: NA_0025_Example_Header
%
% Assumptions: None
%
% Inputs:
%   List of input arguments
%
% Outputs:
%   List of output arguments

%
% $Date: August 27, 2012
% ________________________________________

Rationale

  • Readability

  • Verification and Validation

  • Workflow

  • Code Generation

See Also

  • NASA Orion style guideline jh_0073: eML Header

Last Changed

V3.0

Model Advisor Check

Not applicable

Introduced in R2013a