다음: 명령어 설명 예시, 상위 문서: 설명 방법   [차례][찾아보기]


1.3.5.1 함수 설명 예시

함수 설명문은 함수 이름으로 시작합니다. 매개변수 목록이 같은 줄에 이어 기재됩니다. 매개변수에서 사용하는 이름 또한 설명문 중간에 기재됩니다.

함수를 호출하는 형식을 모두 나열하고 나면, 다음 줄에는 한 줄짜리 간략한 함수 요약이 있습니다.

입출력에 관한 요약 뒤에는 함수 사용례와 셈법 사용 유의 사항, 관련 함수 목록이 나옵니다.

 foo라는 가짜 함수에 대한 설명입니다.

foo (가로)
foo (가로, 세로)
foo (가로, 세로, …)

세로에서 가로를 빼고, 남은 매개변수를 모두 더해 반환합니다.

x는 반드시 숫자인 스칼라, 벡터, 배열이여야 합니다.

선택 입력인 y는 설정되지 않으면, 기본값인 19입니다.

예시:

foo (1, [3, 5], 3, 9)
     ⇒ [ 14, 16 ]
foo (5)
     ⇒ 14

일반적으로는,

foo (w, 가로, 세로, …)
≡
가로 - w + 세로 + …

See also: bar

매개변수 이름에 형식(예:정수 또는 행렬)을 포함하면, 해당 매개변수는 해당 형식이어야 합니다.
이름이 객체인 매개변수는 어떤 형식이든 가능합니다. 그외의 이름인 매개변수(예: new_file)는 함수 설명에서 안내합니다. 일부 절에서는, 여러 함수에 쓰인 매개변수의 공통 기능이 설명문 앞쪽에 실려 있습니다.


다음: 명령어 설명 예시, 상위 문서: 설명 방법   [차례][찾아보기]