외부에 공개되는 코드인 경우나 굉장히 많은 수의 인원이 같이 개발하는 경우 문서화를 위해서 주석을 다는 경우는 많습니다.
하지만 오히려 최근의 정석은 주석은 가능한한 최대한 달지 않는 것입니다.
그래서 함수의 이름이나 변수의 이름을 지을 때 최대한 이해하기 쉬운 방향으로 지어야 합니다.
주석을 달지 않아야 하는 이유는 코드를 수정하다보면 주석도 같이 수정해야할 필요성이 생기기 때문에 비효율적이고, 실수로 주석을 수정하지 않게 되면 코드 리딩에 혼란만 주게 되기 때문입니다.