이전: 여러 줄 주석, 상위 문서: 주석   [차례][찾아보기]


2.7.3 주석과 도움말 체계

help 명령어(도움말 명령 보기)은 함수 주석의 첫 번째 덩어리를 찾고, 이를 문서화 문자열로 반환합니다. 이 말은 내장 함수 도움말을 얻는 help 명령어가 적절하게 작성한 사용자 정의 함수에서도 작동한다는 뜻입니다. 예를 들어, 아래와 같이 함수 f를 정의하면,

function xdot = f (x, t)

# usage: f (x, t)
#
# This function defines the right-hand
# side functions for a set of nonlinear
# differential equations.

  r = 0.25;
  …
endfunction

help f 명령은 다음과 같이 반환합니다.

 usage: f (x, t)

 This function defines the right-hand
 side functions for a set of nonlinear
 differential equations.

Although it is possible to put comment lines into keyboard-composed, throw-away Octave programs, it usually isn’t very useful because the purpose of a comment is to help you or another person understand the program at a later time.

현재 help 구문 분석기는 앞 도움말 글월로 한 줄 주석만(한 줄 주석 참고) 인식하며, 범위 주석은 인식하지 못합니다.