4장. 주석

❤️ 좋은 주석

1. 법적인 주석 : 소스파일 첫 머리에 주석으로 들어가는 저작권 정보와 소유권 정보
2. 정보를 제공하는 주석 : 기본적인 정보를 제공하는 주석 ex) 추상 메서드가 반환할 값 등
3. 의도를 설명하는 주석 : 결정에 깔린 의도를 설명하는 주석
4. 의미를 명료하게 밝히는 주석 : 인수나 반환값이 표준 라이브러리나 변경하지 못하는 코드에 속한다면 의미를 명료하게 주석으로 표시한다
5. 결과를 경고하는 주석 : ex) 특정 케이스를 껴야하는 이유를 설명하는 주석
6. TODO주석 : 당장 구현하기 어려운 업무를 기술한다
7. 중요성을 강조하는 주석 : 자칫 대수롭지 않다고 여겨질 무언가의 중요성을 강조하기 위해 사용

🙅🏻‍♀️ 나쁜주석

1. 주절거리는 주석 : 특별한 이유 없이 남긴 주석
2. 같은 이야기를 중복하는 주석 : 코드 내용을 그대로 중복하거나 헤더에 달린 주석과 같은 내용을 설명하는 주석
3. 오해할 여지가 있는 주석 : 잘못된 정보를 설명하는 주석
4. 이력을 기록하는 주석 : 예전에는 모든 모듈 첫머리에 변경 이력을 기록하고 관리하는 관례가 바람했다 당시에는 소스코드 관리 시스템이 없었기 때문이다, 현재는 소스코드 관리 프로그램이 잘 되어있으므로 이력을 기록하는 주석은 좋지않다
5. 있으나 마나 한 주석 : 당연한 사실을 말하는 주석
6. 위치를 표시하는 주석 : 소스코드 특정위치를 표시하는 주석은 가독성을 낮춘다
7. 닫는 괄호에 다는 주석 : 중첩이 심하고 장황한 함수라면 의미가 있지만 그렇지 않으면 지저분한 코드가 된다
8. 주석으로 처리한 코드 : 사용하지 않는 코드를 주석으로 남겨두면 쓸모없는 코드가 점차 쌓여간다
9. 전역정보 : 주석은 근처에 있는 코드만 기술해야한다

‼️ 나의생각

유지보수 하게될 사람을 위해 주석을 남겨두는것이 좋은것이라고 생각했었는데
4장을 읽어보니 주석없이 코드만으로 이해가능한 코드가 좋은 코드라는것을 깨닳았다
책에서 설명하고있는 나쁜주석 중에 "닫는 괄호를 다는 주석"은 그동안 코드의 가독성을 높여준다고 착각하고있었다! 그리고 실무에서 혹시나 하는 마음에 사용하지 않는 코드도 주석으로 많이 남겨두었던것이 생각났다 좋은 코드를 위해서 지우도록 노력해봐야겠다