주석

주석(comment)은 설명문이다. 문학 책에 실려 있는 소설에서, 어려운 단어가 나오면 페이지의 맨 밑에서 뜻을 풀어 알려주는 것처럼 말이다. 남이 짠 코드를 본 적이 있거나, 내 코드를 남이 본 경험이 있다면 주석이 왜 중요한지 알 것이다. 코드의 이해를 돕기 때문이다. 주석으로 나쁜 코드를 회피하지 말라고 하지만, 아무리 가독성에 신경쓴다고 하더라도 코드의 복잡도가 늘어나면 주석 없이는 의도를 파악하기 힘들기 마련이다.

대부분의 프로그래밍 언어들은 일반적으로 한 줄짜리 주석에 slash(/)를, 여러 줄짜리 주석에 slash와 asterisk(*)를 섞어 사용한다. Java의 예를 보자.

그리고 아래는 Python의 예다.

한 줄짜리 주석에는 내용의 맨 앞에 sharp(#) 기호를 사용하고, 여러 줄짜리 주석에는 내용에 세 개의 double quote(""")를 감싸 표현한다. 대부분의 경우 #을 사용하는 전자의 표현식을 사용한다. 참고로 쉘 스크립트와 Ruby에서 주석을 #으로 표현한다.

후자의 주석 표현에서 사용하는 세 개의 double quote로 감싸진 문자열은, 사실 파이썬에서 문자열 리터럴 표현식이기도 하다.(파이썬에는 4가지의 문자열 리터럴 표현식이 있다 : ', ", ''', """) 따라서 값으로써 관리하기에 더 유연하기 때문에, 파이썬에서는 이를 함수나 클래스 정의의 맨 위에 사용하여 docstring(문서화 문자열)이라는 이름의 주석으로 사용하도록 권고한다. 실제로 #을 사용한 주석은 런타임으로 넘어가며 무시되지만, """를 사용한 주석은 런타임에서도 그대로 유지된다. 결론은, 여러 줄에 걸쳐 주석 처리를 하는 것을 포함한 일반적인 경우에는 #을 사용하는 것이 좋다는 것이다.