프로그램에 대한 도움말 추가하기

이 예제에서는 작성하는 프로그램에 대한 도움말을 제공하는 방법을 보여줍니다. 도움말 텍스트는 help 함수를 사용할 때 명령 창에 나타납니다.

프로그램의 시작 부분에 주석을 삽입하여 도움말 텍스트를 생성합니다. 프로그램이 함수를 포함하는 경우 함수 정의 라인(function 키워드가 있는 라인) 바로 아래에 도움말 텍스트를 배치합니다. 함수에 arguments 블록이 포함된 경우 arguments 블록 바로 아래에 도움말 텍스트를 배치할 수도 있습니다.

예를 들어, addme.m이라는 파일에 도움말 텍스트를 포함하는 함수를 생성해 보겠습니다.

function c = addme(a,b)
% ADDME  Add two values together.
%   C = ADDME(A) adds A to itself.
%
%   C = ADDME(A,B) adds A and B together.
%
%   See also SUM, PLUS.

switch nargin
    case 2
        c = a + b;
    case 1
        c = a + a;
    otherwise
        c = 0;
end

명령줄에 help addme를 입력하면 도움말 텍스트가 명령 창에 표시됩니다.

addme  Add two values together.
    C = addme(A) adds A to itself.

    C = addme(A,B) adds A and B together.
 
    See also sum, plus.

첫 번째 도움말 텍스트 라인(대개 H1 라인이라고 함)은 일반적으로 프로그램 이름과 간단한 설명을 포함합니다. 현재 폴더 브라우저와 help 함수 및 lookfor 함수는 H1 라인을 사용하여 프로그램에 대한 정보를 표시합니다.

% See also로 시작하는 라인에 있는 도움말 텍스트의 끝에 함수 이름을 포함시켜 See also 링크를 생성합니다. 함수가 검색 경로 또는 현재 폴더에 있는 경우 help 명령은 이러한 함수 이름 각각을 해당 도움말에 대한 하이퍼링크로 표시합니다. 그렇지 않을 경우, help는 함수 이름을 도움말 텍스트에 나타나는 그대로 출력합니다.

도움말 텍스트에 웹사이트에 대한 하이퍼링크(URL 형태)를 포함시킬 수 있습니다. HTML <a></a> 앵커 요소를 포함시켜 하이퍼링크를 생성합니다. 앵커 내에서 matlab: 문을 사용하여 web 명령을 실행합니다. 예를 들면 다음과 같습니다.

% For more information, see <a href="matlab: 
% web('https://www.mathworks.com')">the MathWorks Web site</a>.

빈 라인(% 포함 안 함)으로 도움말 텍스트를 끝낼 수 있습니다. 이 경우 도움말 시스템은 도움말 텍스트 블록 뒤에 나오는 주석 라인을 모두 무시합니다.

참고

동일한 이름을 갖는 프로그램이 여러 개 있는 경우 help 명령은 함수 우선 순위(Function Precedence Order)에 설명되어 있는 규칙을 적용하여 표시할 도움말 텍스트를 결정합니다. 그러나, 프로그램 이름이 MathWorks^® 함수와 동일한 경우 상황별 메뉴의 선택 항목에 대한 도움말 옵션을 사용하면 항상 MathWorks 함수에 대한 문서가 표시됩니다.

참고 항목

help | lookfor

외부 웹사이트

Programming: Structuring Code (MathWorks Teaching Resources)