5. 함수 5.5 DocString

C급 개발자와 함께하는 파이썬

5.5 DocString

파이썬은 설명(Documentation) 문자열(String) 이라고 불리우는, 짧게 줄여서 DocStrings라

불리우는 편리한 기능을 가지고 있습니다. DocString은 여러분이 만든 프로그램을 알아보기 쉽게해 주고, 또 후에 프로그램에 대한 설명서를 작성할 때 유용하게 사용될 수 있는 중요한 도구입니다. 아래 예제와 같이, DocString은 프로그램이 실행중일 때도 읽어올 수 있습니다.

함수에 포함된 첫 논리적 명령행에 적어둔 문자열은 함수의 DocString이라고 불리웁니다. 여기에서 설명하는 DocString은 모듈과 클래스에도 똑같이 적용됩니다.

위에서 정의한 함수의 맨 윗 부분(‘’’ 작은 따옴표 세개로 묶여진 - 큰따옴표도 동일한 역할)은 함수를 실행할 때 아무런 동작을 하지 않습니다.  하지만 __doc__로 호출하면 함수에서 첫번째로 ‘’’ 세개의 따옴표로 묶인 문자열을 출력합니다.

위 내용은 이전 함수와 동일하고 아래 ‘’’두번째 문자열 입니다. 출력이 되는지 확인해 보겠

습니다.‘’’ 이 부분만 다르게 코딩되었습니다. 그런데 함수를 실행시켜도 두번째 따옴표 묶음은 출력되지 않는것을 확인하였습니다. docString은 첫번째 세개의 따옴표로 묶인 내용만을 가져오는것을 확인하였습니다.

이 기능을 잘 활용하면 함수 또는 모듈 그리고 클래스의 상세한 정보를 출력할수 있습니다. 쉬운 함수라고 하더라도 docString을 잘 활용하여 멋진 코딩을 하시기 바랍니다.