10.Python Comments, Doc String Usage Summary.

10.Python Comments, Doc String Usage Summary.

Python 주석과 docstring 사용법을 정리.

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

주석은 Code에 영향 X.

Docstring은 코드의 문서화에 도움이 되는 문자열.

""" <= 쌍따옴표 3개를 사용하여 docstring을 작성. (""" 내용 """).

Docstring을 사용해 여러 줄의 주석을 작성 => #를 추천.

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

주석과 docstring은 출력 결과에 영향 X.

Help() 함수를 사용하여 docstring 내용을 확인.

즉 help 함수는 모듈 or 함수의 사용법이 궁금할 때 사용.

docstring 내용은 _doc_ 속성에 저장.

Cf) 주석과 docstring 사용이 필수적인 건 X.

단지 다른 사람이 이해하기 힘든 코드에는 반드시 주석, docstring을 사용.