좋은 주석을 적는 방법

1. 코드 내용을 그대로 반복하는 (추가 정보가 없는) 주석은 적지 마라

 

2. 주석으로 코드를 설명하지 말고 코드를 다시 짜라

 

3. 명확한 주석을 적을 수 없다면 코드에 문제가 있을 수 있다

 

4. 주석을 보고 더 헷갈린다면 그 주석은 지워야 한다

 

5. 불필요하거나 중복된다고 생각할 수 있는 코드, 다른 누군가가 단순화 할 수 도 있다 생각되는 코드에는 주석을 달아 설명하는 것이 좋다

 

6. 복사한 코드라면 원본 출처를 주석에 밝히자

 

7. 도움이 될만한 외부 참조 링크를 포함하라

 

8. 코드를 수정할 때, 특히 버그를 수정할 때 주석을 추가하라

 

9. 주석으로 불완전환 구현을 표시하라 (기술 부채 측정을 위해)

 

 

 

Reference

신주용 / 좋은 주석을 적는 방법 | 커리어리

Best practices for writing code comments