파이썬 주석, docstring 사용법 정리 (파이썬 help 함수, __doc__ 속성)

파이썬(Python) 주석과 docstring 사용법을 정리합니다.

파이썬 주석, docstring 사용법

파이썬 주석

파이썬에서는 #기호를 사용하여 주석을 표현한다.

주석은 코드에 어떠한 영향도 미치지 않는다.

파이썬 docstring

docstring은 코드의 문서화에 도움이 되는 문자열을 말한다.

쌍따옴표 세개를 사용하여 docstring을 작성한다. (""" 이런 저런 내용 """)

docstring을 사용하여 여러줄의 주석을 작성할 수 있다. (그냥 #을 추천)

모듈 파일 처음이나 함수, 클래스 선언 다음 라인에 docstring을 작성한다.

중요한 내용을 docstring 첫줄에 작성 후, 한 칸 띄고 자세한 내용을 적는다.

파이썬 help() 함수와 __doc__ 속성

주석과 docstring은 출력결과에 영향을 미치지 않는다.

help() 함수를 사용하여 docstring 내용을 확인할 수 있다.

(help함수는 모듈이나 함수의 사용법이 궁금할 때 사용된다.)

docstring 내용은 __doc__ 속성에 저장된다.

파이썬 주석, docstring 사용 예

파이썬 라이브러리 폴더에 있는 파일을 열어보면 주석과 docstring이 여기저기 사용된 것을 확인할 수 있다.

help함수로 print, sum함수 docstring을 확인하는 모습

파이썬 프로그래밍을 할 때 주석과 docstring 사용이 필수적인 것은 아닙니다. 하지만 다른 사람이 이해하기 힘든 코드에는 반드시 주석, docstring을 사용하기 바랍니다. 모두의 정신 건강을 위해!

파이썬(Python) 프로그래밍 시작하기 (파이썬 설치 및 실행)

파이썬 print 함수 사용법 정리 (파이썬 화면 출력)

파이썬 input 함수 사용법 정리 (파이썬 키보드 입력)

파이썬 자료형 비교 정리 (파이썬 정수, 실수, 불, 문자열, 리스트, 튜플, 집합, 사전)

파이썬 산술 연산자, 할당 연산자 사용법 정리