Main Content

도움말 요약 파일 생성하기 — Contents.m

Contents.m 파일이란?

Contents.m 파일은 특정 폴더에 있는 프로그램에 대한 정보를 요약하여 제공합니다. help, doc, ver 함수는 Contents.m 파일을 참조하여 폴더에 대한 정보를 표시합니다.

Contents.m 파일에는 주석 라인만 들어 있습니다. 처음 두 줄의 라인은 폴더에 대해 설명하는 헤더입니다. 이후 라인에는 폴더의 프로그램 파일이 설명과 함께 나열됩니다. 선택적으로, 파일을 그룹화하고 범주 설명을 포함할 수 있습니다. 예를 들어, codetools 폴더에서 사용할 수 있는 함수를 보겠습니다.

help codetools
  Commands for creating and debugging code
  MATLAB Version 9.3 (R2017b) 24-Jul-2017 
 
  Editing and publishing
    edit                   - Edit or create a file
    grabcode               - Copy MATLAB code from published HTML
    mlint                  - Check files for possible problems
    publish                - Publish file containing cells to output file
    snapnow                - Force snapshot of image for published document
  
  Directory tools
    mlintrpt               - Run mlint for file or folder, reporting results in browser
    visdiff                - Compare two files (text, MAT, or binary) or folders

   ...

다른 사람이 프로그램 파일 요약을 보지 못하게 하려는 경우, 폴더에 빈 Contents.m 파일을 넣으십시오. Contents.m 파일이 비어 있으면 help foldername에서 No help found for foldername이 보고됩니다. Contents.m 파일이 없으면, helpdoc 명령을 사용하여 폴더에 있는 모든 프로그램 파일에 대해 생성된 목록을 표시할 수 있습니다.

Contents.m 파일 생성하기

폴더에 기존 프로그램 파일이 있는 경우, Contents.m 파일을 만드는 가장 쉬운 방법은 콘텐츠 리포트를 사용하는 것입니다. 콘텐츠 리포트의 주요 용도는 기존 Contents.m 파일이 최신인지 확인하는 것입니다. 반면, 콘텐츠 리포트는 Contents.m의 존재 여부도 확인하며 폴더의 내용을 기반으로 새 파일을 생성할 수도 있습니다. 파일을 만들려면 다음 단계를 따르십시오.

  1. 현재 폴더 브라우저에서 프로그램 파일이 있는 폴더로 이동합니다.

  2. 을 클릭한 다음 리포트 > 콘텐츠 리포트를 선택합니다.

  3. 리포트에서 Contents.m 파일을 만들라는 메시지가 표시되면 를 클릭합니다. 새 파일에는 폴더에 있는 모든 프로그램 파일의 이름이 포함되며, 포함 가능한 경우, 항상 설명 라인(비어 있지 않은 최초의 주석 라인)이 포함됩니다.

  4. 생성된 파일을 편집기에서 열고, 두 번째 주석 라인이 다음 형식이 되도록 파일을 수정합니다.

         % Version xxx dd-mmm-yyyy

    날짜에 공백을 포함하지 마십시오. 이 주석 라인으로 인해 ver 함수가 버전 정보를 검색할 수 있습니다.

참고

MATLAB®에서 콘텐츠 리포트를 생성할 때 라이브 스크립트나 라이브 함수는 포함되지 않습니다.

기존 Contents.m 파일 확인하기

다음과 같이, 콘텐츠 리포트를 사용하여 Contents.m 파일이 폴더의 현재 내용을 반영하는지 여부를 확인합니다.

  1. 현재 폴더 브라우저에서 Contents.m 파일이 있는 폴더로 이동합니다.

  2. 을 클릭한 다음 리포트 > 콘텐츠 리포트를 선택합니다.

참고

경로가 UNC(범용 명명 규칙) 경로, 즉 \\로 시작하는 경로인 경우에는 리포트를 실행할 수 없습니다. 대신, 시스템의 실제 하드 드라이브나 매핑된 네트워크 드라이브를 사용하십시오.

콘텐츠 리포트는 다음 사항을 확인합니다.

Contents.m 파일에 대한 확인 사항세부 정보
이 파일이 있는지 여부폴더에 Contents.m 파일이 없으면 리포트에서 이 파일을 만들 수 있습니다.
폴더에 있는 모든 프로그램이 포함되었는지 여부누락된 프로그램은 회색 강조 표시로 나타납니다. 최종 사용자에게 노출하지 않으려는 프로그램은 추가할 필요가 없습니다.
존재하지 않는 파일이 잘못 나열되었는지 여부폴더에 존재하지 않는 프로그램이 나열되면 해당 프로그램은 분홍색 강조 표시로 나타납니다.
프로그램 파일 설명과 일치하는지 여부리포트는 Contents.m의 파일 설명을 해당 파일에서 비어 있지 않은 최초의 주석 라인과 비교합니다. 차이가 있는 경우 분홍색 강조 표시로 나타납니다. 프로그램 파일이나 Contents.m 파일을 업데이트할 수 있습니다.
파일 이름과 설명 사이에 일관된 간격을 사용하는지 여부리포트 상단에 있는 간격 맞춤을 클릭하여 정렬을 수정합니다.

모두 수정을 클릭하여 제안된 변경 사항을 모두 수용하거나 Contents.m 편집을 클릭하여 편집기에서 파일을 열 수 있습니다.

참고 항목

| |