더북(TheBook)

내가 코드 주석에 반대하는 것처럼 들린다면, 사실은 정반대다. 불필요한 주석을 줄이는 것은 유용한 주석을 보석처럼 빛나게 하며 이것은 주석을 유용하게 만드는 유일한 방법이다. 주석을 작성할 때 건축가 시난처럼 생각하라. “이것에 대한 설명이 필요한 사람은 누구일까?” 설명이 필요할 경우에는 최대한 명확하게 하고, 자세히 설명하고, 필요할 경우 ASCII 다이어그램을 그려 넣기도 하라. 같은 코드를 작업하는 개발자가 여러분에게 와서 코드의 기능을 묻거나 설명을 잊어버려서 코드를 잘못 수정하지 않도록, 원하는 만큼 문단을 작성하라. 프로덕션 서버가 중단될 때 그 코드를 올바르게 수정하는 것은 여러분에게 달려 있다. 여러분은 다른 모든 사람과 마찬가지로 이것에 대한 의무를 가진다.

공용 API와 같이 사용자가 코드에 접근할 수 없는 경우에는 주석이 유용한지 여부에 관계없이 주석을 작성해야 하는 경우가 있다. 그렇다고 기록된 주석이 코드를 이해하기 쉽게 만든다는 것을 의미하지는 않는다. 작고 이해하기 쉬운 깨끗한 코드를 작성해야 한다.

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