개발자에게 꼭 필요한 바이블인 스택오버플로우에 좋은 주석을 작성하기 위한 "코드 주석 작성 모범 사례" 글이 있어서 K식으로 정리해본다. 주석은 프로그램을 개발자가 읽고 이해할 수 있게 도와주는 도우미 역할을 해준다. 읽기 좋은 코드는 주석이 필요없다와 같은 오만한 말도 있지만 개인적으로 동의하지 않는다. 코드를 읽는 다른 사람은 배경 지식과 IT 지식이 모두 다른 상태에서 코드만을 보고 프로그램을 이해하는 것은 이정표 없이 길을 찾으라는 말과 같으니까. 반대로 좋지 못한 나쁜 주석은 프로그램을 이해하는데 방해가 되며 차라리 없느니만 못한 결과를 초래하게 된다. 그렇기 때문에 우리는 좋은 주석을 작성하기 위해 주의를 기울여야 한다. 1. 주석에 코드를 담지 말라. if (x > 3) { … } // if..