mp_0032: 함수 헤더 정보

R2024b 이후

지침 발행물

Control Algorithm Modeling Guidelines - Using MATLAB®, Simulink®, and Stateflow®

하위 ID 권장 사항

  • JMAAB — a

MATLAB 버전

모든 버전

규칙

하위 ID a

필요한 정보는 함수 헤더에 기술되어야 합니다.

추가 정보

설명 항목에는 개요, 처리 세부 정보, 입력 및 출력 인수, 관리 정보, 기타 관련 정보가 포함될 수 있습니다. 설명 항목의 조합은 메인 함수(main function)와 부 함수(sub-function)에 맞게 필요에 따라 조정되어야 합니다.

예제 — 올바름
function ret = sample(arg1)
% Overview
% sample program
% Processing details
% Adds arg1 and foo and returns the value
% Arguments
% arg1 : First term
% Return Value
% ret : Result of addition
% Change History
% -------------------------------
% 2018/3/14 Created
% -------------------------------
% 2018/3/30 Added comments

foo = 3;
ret = arg1 + foo;
end
사용자 지정 파라미터

함수 헤더에 대한 설명 항목.

근거

하위 ID a:

  • 공유할 정보를 명확하게 명시하면 가독성과 유지 관리성이 향상됩니다.

검증

모델 어드바이저 검사: Check function headers (함수 헤더 검사) (Simulink Check)

마지막 변경

R2024b

버전 내역

R2024b에 개발됨