Python에서 함수 문서 출력하기

함수 본문에는 수행되는 작업의 핵심을 설명하는 문자열을 작성할 수 있습니다. 이러한 문자열은 일반적으로 함수 문서로 간주됩니다. 이 문자열은 작은따옴표로 묶여 함수 본문의 첫 번째 줄에 배치됩니다. 이를 읽으려면 함수 이름을 매개변수로 전달하는 특수 함수 help를 사용해야 합니다.

두 숫자를 합산하는 함수가 있다고 가정해 보겠습니다. 이에 대한 정보가 포함된 문자열이 주석으로 추가되었습니다:

def getSum(num1, num2):
	'이 함수는 두 숫자를 더합니다'
	return num1 + num2

help를 호출하여 getSum에 어떤 주석이 달려 있는지 알아봅시다:

help(getSum)

코드를 실행한 후 콘솔에는 함수 이름과 해당 문서가 포함된 문자열이 나타납니다:

Help on function getSum in module __main__:

getSum(num1, num2)
	이 함수는 두 숫자를 더합니다

help 함수를 사용하면 표준 함수의 문서도 읽을 수 있습니다. print 함수에 대한 정보를 알아봅시다:

help(print)

함수에서 문서 문자열만 출력하려면 help에 함수 이름 뒤에 서비스 구성 .__doc__를 전달해야 합니다:

help(print.__doc__)

월 이름 목록을 매개변수로 받아 대문자로 출력하는 함수를 만드세요. 함수의 작동 방식을 문서에 설명하고 콘솔에 출력하세요.

sum 함수에 대한 전체 문서를 출력하세요.

len 함수에 대한 문서 문자열만 출력하세요.