이 번역 페이지는 최신 내용을 담고 있지 않습니다. 최신 내용을 영문으로 보려면 여기를 클릭하십시오.

라이브 함수에 대한 도움말 추가하기

사용자는 본인이 작성한 라이브 함수에 대한 도움말을 만들 수 있습니다. 도움말 텍스트는 help 명령을 사용할 때 명령 창에 나타납니다. doc 명령을 사용하여 별도의 브라우저에 도움말 텍스트를 표시할 수도 있습니다.

파일 시작 부분, 즉 함수 정의 라인(function 키워드가 포함된 라인) 바로 앞에 텍스트를 삽입하여 도움말 텍스트를 만듭니다.

예를 들어, 다음 코드를 사용하여 라이브 함수 addme.mlx를 만듭니다.

function c = addme(a,b)

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

함수를 설명하는 도움말 텍스트를 추가합니다.

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

흔히 H1 라인이라고 하는 도움말 텍스트의 첫 번째 라인에는 주로 함수에 대한 간략한 설명이 포함됩니다. 함수에 대한 도움말을 표시할 때 MATLAB^®은 함수 이름을 먼저 표시하고 다음으로 H1 라인을 표시합니다. 그런 다음, MATLAB은 함수의 구문을 표시합니다. 마지막으로 MATLAB은 나머지 도움말 텍스트를 표시합니다.

"참고 항목" 링크를 추가하려면 단어 See also로 시작되고 다음에 함수 이름 목록이 오는 텍스트 라인을 도움말 텍스트 끝에 추가하십시오. 함수가 검색 경로 또는 현재 폴더에 있는 경우 help 명령은 이러한 함수 이름 각각을 해당 도움말에 대한 하이퍼링크로 표시합니다. 그렇지 않을 경우, help는 함수 이름을 도움말 텍스트에 나타나는 그대로 출력합니다.

참고

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

도움말 브라우저에 표시된 문서를 더욱 개선하려면 텍스트의 서식을 지정하고 하이퍼링크, 이미지, 수식, 예제 코드를 추가할 수 있습니다. 예를 들어, addme 함수에서 H1 라인을 선택한 후 라이브 편집기 탭에서 일반 텍스트 스타일을 제목으로 변경해 보겠습니다. 그런 다음, 커서를 두 번째 구문 설명 끝에 놓고 삽입 탭으로 이동하여 수식을 선택합니다. 수식 c = a + b를 입력하고 Esc 키를 누릅니다. 마지막으로 삽입 탭에서 코드 예제 > MATLAB을 선택하고 예제 두 개를 추가합니다. 라이브 편집기에서 파일의 서식을 지정하는 방법에 대한 자세한 내용은 라이브 편집기에서 텍스트의 서식 지정하기 항목을 참조하십시오.

doc 명령을 사용하여 별도의 브라우저에 도움말 텍스트를 표시할 수도 있습니다.

파일의 시작 부분에 주석을 삽입하여 라이브 함수에 도움말을 추가할 수도 있습니다. help 명령과 doc 명령을 사용하면 파일의 시작 부분에 있는 텍스트가 표시되는 방식과 유사하게 파일 시작 부분의 주석이 도움말 텍스트로 표시됩니다. 주석을 사용하여 도움말을 추가하는 방법에 대한 자세한 내용은 프로그램에 대한 도움말 추가하기 항목을 참조하십시오.

참고 항목

export

관련 항목

• 라이브 함수 만들기
• 라이브 편집기에서 텍스트의 서식 지정하기
• 라이브 스크립트 및 라이브 함수 공유하기