[Python] 주석

프로그래밍에 있어 주석(Comment)은 정말 중요합니다. 굉장히 아이러니하지만, 내 코드를 내가 이해하지 못하는 경우가 생각보다 많습니다. 조건문의 조건식이 복잡해지고, 반복문이 다중으로 구성되는 등, 코드의 복잡도가 늘어날수록 주석 없이는 코드를 이해하기 힘들어집니다. 주석은 컴파일 타임에 제외되는, 가독성을 높이기 위한 한 줄 이상의 설명문입니다.

많은 프로그래밍 언어들은 주석을 //로 시작하여 작성하고, 여러 줄에 걸쳐 주석을 작성하는 경우 /* */ 형태를 사용합니다.

Python은 #으로 시작하는 문장을 주석으로 간주합니다. 여러 줄에 걸쳐 주석을 작성하는 경우 """(큰 따옴표 3개) 사이에 작성하면 됩니다.

사실, '클린 코드(Clean code)'라는 명저에서는 '주석은 설명을 붙여 나쁜 코드를 회피하려는 것'이라고 설명하며 주석에 대해 회의적인 입장을 가지고 있습니다. 실제로 주석 없이도 쉽게 이해 가능한 매우 깔끔한 코드를 작성하는 게 순효과가 더 많기도 합니다. 그러나 우리는 그만큼의 직관성을 가진 코드를 작성하기 위한 경험이 부족하니, 지금은 '클린 코드'가 말했던 대로 주석으로나마 나쁜 코드를 회피할 수밖에 없는 입장입니다. 주석 없이도 이해되는 코드를 작성하는 것은 개발자의 역량이므로, 무조건 주석을 붙이는 것보다 깔끔하고 직관적인 코드를 작성하는 것에 더 집중하는 것이 좋을 것 같다는 게 제 입장입니다.