파이썬 주석은 코드의 분명성을 위해 필수적이며, '#' 기호, souvent appelé octothorpe로 시작합니다. 주석은 행의 끝까지 확장되어 개발자가 코드의 기능을 설명할 수 있습니다. 이러한 주석은 싱글 라인 주석입니다. 파이썬에는 특정 멀티라인 주석 구문이 없습니다. 주석은 코드와 함께 인라인으로 사용하거나 더 큰 설명을 위해 별도의 행에 사용할 수 있습니다. 제공된 예에서는 ANSI 이스케이프 코드의 목적을 분명하게 하기 위해 주석을 사용하는 것을 보여줍니다. 주석은 코드가 "Hello!"를 "Goodbye!"로 대체하는 방법, 즉 커서를 이동하고 행을 지우는 것을 설명합니다. 또한 Windows와의 호환성 문제를 강조하여 정보적인 주석의 중요성을 강조합니다. 코드의 가독성을 위해 필수적이지만, 주석은 코드의 '왜'를 설명하는 것이 아니라 '무엇'을 설명하는 것을 피해야 합니다. 과도한 주석은 가독성과 유지 보수성을 저하할 수 있습니다.
pythonmorsels.com
Python Morsels: Commenting in Python
