더북(TheBook)

주석은 코드에서 명확하지 않은 기능을 문서화할 때 가장 유용하다. 코드를 읽는 사람이 코드가 무엇을 하는지 이해할 수 있게 해야 한다. 즉, 왜(why)를 설명하는 게 유용하다.

다음 주석은 코드와 중복되므로 쓸모가 없다.

v = 5 # v에 5를 할당

다음 주석은 코드에 없는 유용한 정보를 담고 있다.

v = 5 # 속도는 미터/초 단위

좋은 변수 이름을 사용하면 주석을 덜 사용할 수 있지만, 긴 변수 이름은 복잡한 표현식을 읽기 어렵게 만들기도 하므로 여기에는 장단점이 있다.

신간 소식 구독하기
뉴스레터에 가입하시고 이메일로 신간 소식을 받아 보세요.