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

사용자는 본인이 작성한 라이브 함수에 대한 도움말을 만들 수 있습니다. 도움말 텍스트는 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

함수 정의 라인 바로 앞에 라인을 삽입합니다. 그런 다음 라이브 편집기 탭으로 이동하여 텍스트 버튼을 클릭합니다. 코드 라인이 텍스트 라인이 됩니다. 함수를 설명하는 도움말 텍스트를 추가합니다.

Add two values
C = ADDME(A) adds A to itself.
C = ADDME(A,B) adds A and B.

"참고 항목" 링크를 추가하려면 도움말 텍스트 끝에 빈 텍스트 라인을 추가하고 단어 See also로 시작되고 다음에 함수 이름 목록이 오는 라인을 추가합니다.

See also SUM, PLUS

함수가 검색 경로 또는 현재 폴더에 있는 경우 help 명령은 이러한 함수 이름 각각을 해당 도움말 텍스트에 대한 하이퍼링크로 표시합니다. 그렇지 않을 경우, help는 함수 이름을 도움말 텍스트에 나타나는 그대로 출력합니다. 링크를 올바르게 표시하려면 See also 텍스트를 포함하는 라인 앞에 빈 라인이 있어야 합니다.

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

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

도움말 텍스트 보기

명령 창에 help addme를 입력합니다. addme 함수에 대한 도움말 텍스트는 명령 창에 함수 이름이 먼저 나타나고 다음으로 도움말 텍스트의 첫 번째 라인(H1 라인이라고도 함)이 나타납니다. 그런 다음, MATLAB^®은 함수의 구문을 표시합니다. 마지막으로 MATLAB은 나머지 도움말 텍스트를 표시합니다.

doc addme를 입력하여 별도의 브라우저에서 서식 지정된 도움말 텍스트를 볼 수 있습니다.

서식 지정된 텍스트 및 예제 추가하기

doc 명령을 사용할 때 표시되는 문서를 더욱 개선하려면 도움말 텍스트의 서식을 지정하고 하이퍼링크, 이미지, 수식, 코드 예제를 추가할 수 있습니다. 도움말 텍스트의 서식을 지정하려면 라이브 편집기 탭으로 이동하여 텍스트 섹션의 옵션 중에서 선택하십시오. 하이퍼링크, 이미지, 수식 및 코드 예제를 삽입하려면 삽입 탭으로 이동한 후 사용 가능한 옵션 중에서 선택하십시오.

예를 들어, addme 함수에서 두 번째 구문 설명에 수식을 추가하고, "참고 항목" 링크 앞에 헤더와 두 개의 MATLAB 코드 예제를 추가하여 예제 섹션을 만들어 보겠습니다.

1. addme 함수에서, 커서를 두 번째 구문 설명 끝에 놓고 삽입 탭으로 이동하여 수식을 선택합니다. 수식 c = a + b를 입력하고 Esc 키를 누릅니다.

2. "참고 항목" 링크 앞의 빈 텍스트 라인에 커서를 놓고 라이브 편집기 탭으로 이동하여 소제목 1 텍스트 스타일을 선택합니다. 단어 Examples를 입력합니다.

3. 삽입 탭으로 이동하여 코드 예제 > MATLAB을 선택합니다. 나타나는 블록에 예제 코드를 입력합니다.

라이브 편집기에서 파일의 서식을 지정하는 방법에 대한 자세한 내용은 라이브 편집기에서 텍스트의 서식 지정하기 항목을 참조하십시오.

참고 항목

export

관련 항목

• 라이브 함수 만들기
• 라이브 편집기에서 텍스트의 서식 지정하기
• 라이브 편집기를 사용하여 실행 가능한 예제 만들기
• 라이브 스크립트와 라이브 함수를 공유하고 내보내는 방법

외부 웹사이트

• Programming: Structuring Code (MathWorks Teaching Resources)