좋은 주석에 대한 소고

코드 작성 시에 주석은 무척 중요하다. 다른 사람 기준은 어떤지 모르겠지만 내가 상각하는 코드 주석은 크게 봐서 2가지로 나눌 수 있다. 메소드, 클래스, 파일 등 코드의 집합에 대한 설명 코드 집합 내부에서 코드 중간에 나타나는 주석 메소드, 클래스 등의 주석은 예를 들어 JavaDoc 형태로 이 메소드와 클래스를 사용하는 다른 개발자들의 이해를 돕기 위해 당연히 적어야 한다. 논란이 되는건 두 번째 주석이다. 개인적으로는 그냥 참고할 만한 책 정도인 클린 코드에서도 주석에 대해 언급한 구절이 있다....

2024-06-30