코드에 주석(Comment) 추가하기

코드를 작성할 때는 해당 코드에 대해 설명하는 주석을 추가하는 것이 좋습니다. 주석을 달아 놓으면 다른 사람들이 자신의 코드를 이해하는 데 도움이 되는 것은 물론 나중에 다시 코드를 살펴볼 때도 쉽게 기억을 떠올릴 수 있습니다. 코드 개발 및 테스트를 진행하는 동안 주석을 사용하여, 실행할 필요가 없는 코드를 주석으로 처리할 수도 있습니다.

라이브 편집기에서는 코드 앞과 뒤에 텍스트 라인을 삽입하여 작업 과정이나 코드를 설명할 수 있습니다. 텍스트 라인은 표준 형식 지정 옵션 및 이미지/하이퍼링크/수식 삽입과 같은 추가적인 유연성을 제공합니다. 자세한 내용은 라이브 편집기에서 라이브 스크립트 만들기 항목을 참조하십시오.

참고

사용 중인 플랫폼의 인코딩과는 다른 인코딩으로 작성된 문자가 있는 텍스트가 포함된 MATLAB^® 코드 파일(.m)을 MATLAB에서 저장하거나 퍼블리시하면 해당 문자는 깨진 텍스트로 표시됩니다. 라이브 스크립트와 라이브 함수(.mlx)에서는 모든 로캘의 문자를 저장하고 표시할 수 있습니다.

의견 추가

MATLAB 코드에 주석을 추가하려면 퍼센트(%) 기호를 사용하십시오. 주석 라인은 코드 파일의 어느 위치에나 나타날 수 있으며, 코드 라인 끝에 주석을 추가할 수도 있습니다.

예를 들면 다음과 같습니다.

% Add up all the vector elements.
y = sum(x)           % Use the sum function.

코드를 주석으로 처리하기

여러 코드 라인을 주석으로 처리하려면 블록 주석 연산자 %{ 및 %}를 사용하면 됩니다. %{ 연산자와 %} 연산자는 각각 도움말 텍스트 블록의 바로 전 라인과 바로 다음 라인에 단독으로 표시되어야 합니다. 이들 라인에는 다른 텍스트를 넣지 마십시오.

예를 들어, 다음과 같이 합니다.

a = magic(3);
%{
sum(a)
diag(a)
sum(diag(a))
%}
sum(diag(fliplr(a)))

특정 코드 라인을 주석으로 처리하려면 해당 코드 라인을 선택하고 편집기 탭 또는 라이브 편집기 탭으로 이동한 후 코드 섹션에서 주석 버튼 을 클릭하면 됩니다. 또는 Ctrl+R을 누를 수도 있습니다. 선택한 코드 라인의 주석 처리를 해제하려면 주석 해제 버튼 을 클릭하거나 Ctrl+Shift+R을 누르십시오. macOS 시스템에서는 주석 처리하려면 Command+/를 사용하고 주석 처리를 해제하려면 Command+Option+/를 사용하십시오. Linux^® 시스템에서는 주석 처리하려면 Ctrl+/를 사용하고 주석 처리를 해제하려면 Ctrl+Shift+/를 사용하십시오.

여러 라인에 걸쳐 있는 한 명령문 중 일부를 주석으로 처리하려면 퍼센트 기호 대신 줄임표(...)를 사용하십시오. 예를 들면 다음과 같습니다.

header = ['Last Name, ',      ...
          'First Name, ',     ...
      ... 'Middle Initial, ', ...
          'Title']

주석 줄 바꿈

기본적으로, 편집기 및 라이브 편집기에 주석을 입력할 때 텍스트가 열 너비 75에 도달하면 줄 바꿈이 수행됩니다. 편집기 및 라이브 편집기는 다음과 같은 경우에는 주석을 줄 바꿈하지 않습니다.

섹션 제목(%%로 시작하는 주석)
연속적인 긴 텍스트(예: URL)
이전 라인에 걸친 글머리 기호 목록 항목(* 또는 #로 시작하는 텍스트)

주석 처리된 텍스트가 줄 바꿈되는 위치를 변경하거나 자동 줄 바꿈을 해제하려면 홈 탭으로 이동한 후 환경 섹션에서 기본 설정을 클릭하십시오. MATLAB > 편집기/디버거 > 언어를 선택하고 주석 형식 지정 기본 설정을 조정합니다. MATLAB Online™에서는 해당 기본 설정을 편집기/디버거 > MATLAB 언어에서 확인할 수 있습니다.

현재 열 너비를 벗어나는 기존 주석이 있는 경우 자동으로 줄 바꿈하려면 편집기 탭 또는 라이브 편집기 탭으로 이동하고 코드 섹션에서 주석 줄 바꿈 버튼 을 클릭하십시오. 예를 들어, 다음과 같이 주석 처리된 라인에 길이가 긴 텍스트가 있다고 가정하겠습니다.

% This is a code file that has a comment that is a little more than 75 columns wide.
disp('Hello, world')

커서를 해당 라인에 놓은 상태로 편집기 탭 또는 라이브 편집기 탭으로 이동하고 코드 섹션에서 주석 줄 바꿈 버튼

을 클릭합니다. 주석이 다음 라인으로 줄 바꿈됩니다.

% This is a code file that has a comment that is a little more than 75
% columns wide.
disp('Hello, world')

주석의 맞춤법 검사하기

주석에 맞춤법 오류가 있는지 검사할 수 있습니다. 맞춤법 검사를 활성화하려면 보기 탭으로 이동한 다음 맞춤법 검사 버튼을 클릭하십시오. 맞춤법 오류가 있을 수 있는 단어에는 파란색 밑줄이 표시됩니다. 맞춤법 오류를 해결하려면 단어를 클릭하고 제안된 정정 사항 중 하나를 선택하십시오. 맞춤법 오류를 무시하도록 선택하거나 플래그가 지정된 단어를 로컬 사전에 추가할 수도 있습니다. 키보드를 사용하여 맞춤법 오류 사이를 이동하려면 Alt+F7 및 Alt+Shift+F7을 사용하십시오.

맞춤법 검사는 MATLAB 코드 파일(.m)과 라이브 코드 파일(.mlx)에서 미국 영어로 지원됩니다. 로컬 사전에서 단어를 제거하려면 MATLAB 기본 설정 폴더(prefdir을 실행할 때 반환되는 폴더)로 이동하여 파일 dict/en_US_userDictionary.tdi를 편집하십시오.

외부 웹사이트

Programming: Structuring Code (MathWorks Teaching Resources)