Main Content

이 페이지는 기계 번역을 사용하여 번역되었습니다. 영어 원문을 보려면 여기를 클릭하십시오.

함수 헤더 확인

검사 ID: mathworks.jmaab_v6.mp_0032

지침: mp_0032: 함수 헤더

설명

함수 헤더에 입력 매개변수로 지정된 설명 항목이 포함되어 있는지 확인합니다.

이 확인은 다음 대상 구성 요소에 적용됩니다.

  • Simulink®의 MATLAB Function 블록.

  • MATLAB®는 Stateflow® 차트의 함수입니다.

  • 모델에서 참조되는 외부 MATLAB 파일입니다.

이 검사에는 Simulink Check™ 라이센스가 필요합니다.

매개변수화 확인

JMAAB 모델링 지침은 하나의 하위 ID만 제공하므로 이 검사에는 하위 검사가 포함되지 않습니다.

참고로 JMAAB 모델링 표준 기관에서 사용하도록 권장하는 지침 하위 ID는 다음과 같습니다.

  • JMAAB — a

분석에 .m 확장자를 가진 파일을 포함하려면 모델에서 참조된 외부 .m 파일 확인을 선택합니다. 확인란은 기본적으로 선택되어 있습니다.

설명 항목 상자에 파이프 기호("|")로 구분하여 함수 헤더에서 확인할 설명 항목을 입력합니다. 설명 항목은 대소문자를 구분하지 않으며 함수 헤더에 어떤 순서로든 나타날 수 있습니다. 기본값은 Overview|Processing content|Arguments|Return value|change history입니다.

함수 헤더의 각 설명 항목은 별도의 줄에 있어야 하며 특수 문자를 포함할 수 없습니다. 예를 들어, 검사에서는 입력 매개변수인 설명 항목의 기본값에 대한 잠재적인 문제에 대해 다음 헤더에 플래그를 지정하지 않습니다.

% Overview
%    sample program
% Processing content
%    Add arg1 and foo and return the value
% Arguments
%    arg1: First term
% Return Value
%    ret: Addition result
% Change History
%     05/24/2022 - added new comments

검사는 설명 항목의 기본값에 대해 다음 함수 헤더에 플래그를 지정합니다.

% Overview --
%    sample program
% Processing content Add arg1 and foo and return the value
% Arguments    arg1: First term
% Return Value
%    ret: Addition result
% Change History !
%     05/24/2022 - added new comments

결과 및 권장 조치

상태권장 조치
하나 이상의 함수 헤더에 지정된 설명 항목이 포함되어 있지 않습니다.기능 헤더에 설명 항목 입력 매개변수로 지정된 설명 항목을 포함합니다.

기능 및 제한 사항

  • 라이브러리에 연결된 블록의 내용을 분석합니다. 기본적으로 입력 매개변수 Follow links는 켜기로 설정됩니다.

  • 마스크된 하위 시스템의 콘텐츠를 분석합니다. 기본적으로 입력 매개변수 Look under masks는 모든로 설정됩니다.

  • 라이브러리 모델에서 실행됩니다.

  • 블록 및 차트를 제외할 수 있습니다.

참조: