나쁜주석 ~ 참고 문헌
전에 썼던 소감과 비슷하지만 코드의 내용을 그대로 적은 주석은 영어를 아는 사람과 모르는 사람에게는 꽤 큰 차이가 있을 것 같다. 그렇다고 그 주석이 좋다는 것은 아니지만 한 눈에 이해를 돕기위해서 쓰는 주석을 나쁘다고만은 못 할 것 같다.
나도 제일 싫어하는 이력을 기록 하는 주석은 특히 옛날 코드에서 굉장히 많이 봤다.
옛날 팀에서도 설정에 수정한 사항이 있으면 의뢰이슈 번호, 날짜 등을 주석으로 다는 것이 의무였는데 설정을 추가하는 것보다 주석을 다는게 더 시간 걸릴 정도로 굉장히 번거로워서 이걸 꼭 해야 하냐고 물어 본적이 있었다. 회사 감사(監査)때 이런 이력이 잘 있는지도 본다고 답변을 받았는데 어차피 git으로 관리하는데 정말 이해할 수 가 없었다.
일본은 뭐든지 기록으로 남기려고 하는 것도 있어서 그런지 사소한 것도 주석으로 달고, 오히려 주석이 없으면 불친절하다는 이야기도 많이 들었다. 굉장히 비효율적이기 때문에 이런 점은 고쳐졌으면 좋겠다. 다들 이 책을 읽어라!
닫는 괄호에 다는 주석, 주석으로 처리한 코드는 가끔 나도 하는 경우가 있기 때문에 조심해야겠다.
이 파트는 공감도 많이 되고 재밌었다.