2022-01-28일 노개북 클린코드

오늘 읽은 부분 : 4장 주석

실제로 나는 주석을 과도하게 썼던 편이었다. 이유는 딱히 협업을 해본적이 많지 않았고 해보더라도 나랑 비슷한 실력의 사람들과 한것이 다이기도 했고, 보통 공부용으로 코드를 짜기때문에 다시봤을때 이해가 잘 되라고 작성을 했던것 같다

하지만 이번 장을 읽으면서 차라리 완벽한 이름과 필요한 만큼에 주석만 썼더라면 더 빨리 이해가 되고 나중에 협업을 한다면 익숙해져 있을 것이라는 생각이 들었다.

 

초보 개발자들이 주석을 다는 이유는 코드의 품질이 낮기 때문이다. 내가 이렇게 코드를 짰는데 이건 이런식으로 돌아가요 라는 식의 과도한 설명이 담겨있다. 하지만 주석을 아무리 쓴다고 해도 코드의 품질이 올라 가는 것은 아니다. 그래서 코드로 의도를 표현하자 함수명이 좀 길면 어떻나 잘 설명할수 있다면 오히려 좋은 방법이다. 

 

코드로만 그 의도를 설명하기에 쉽지 않은 경우, 결과를 경고할때 자칫 대수롭게 여겨질 뭔가의 중요성을 강조할때에는 주석을 쓰자