4장. 주석

1. 책에서 기억하고 싶은 내용을 써보세요.

• 주석은 오래될수록 코드에서 멀어진다. 이는 프로그래머들이 주석을 유지하고 보수하기란 현실적으로 불가능하기 때문이다.
• 주석보다는 코드를 깔끔하게 정리하고 표현력을 강화하는 방향으로 작성해서 주석이 필요없는 방향으로 에너지를 쏟는 것이 좋다.
• 부정확한 주석은 아예 없는 주석보다 훨씬 더 나쁘다.
• 주석은 나쁜 코드를 보완하지 못한다.
• 정말로 좋은 주석은 주석을 달지 않을 방법을 찾아낸 주석이다.
• 예전에는 소스 코드 관리 시스템이 없어서 코드에 변경 사항을 기록했다면 이제는 혼란만 가중하기 때문에 완전히 제거하는 편이 좋다.
• 함수나 변수로 표현할 수 있다면 주석을 달지 마라
• 주석을 달아야 한다면 근처에 있는 코드만 기술해야지 전역 정보(포트번호, 파일 경로 등)같은 시스템의 전반적인 정보를 기술하지 마라.

2. 오늘 읽은 소감은? 떠오르는 생각을 가볍게 적어보세요.

지금까지 코드를 작성하면서 더러운 로직은 개선하기 보다는 주석을 통해서 의미를 전달하려고 했던 것 같다. 하지만 이번 4장을 읽고나서 가장 좋은 주석은 주석을 달지않고 정확하게 의미를 전달하는 것이고 이것이 정말 좋은 개발자가 되기 위한 방법중 하나라고 생각이 들었다.
또한, 나의 잘못된 습관인 변경 이록 기록하기, 의무적으로 주석 기입하기 등 이런 불필표한 주석은 지양해야겠다고 생각되었다. 하지만 히스토리가 중요하듯이 코드를 작성한 의도나 주의사항을 위해서 주석을 다는 것은 허용되는 범위라는 것을 보고 주석은 꼭 필요할 때만 달아야겠다고 다짐했다.

3. 궁금한 내용이 있거나, 잘 이해되지 않는 내용이 있다면 적어보세요.

세줄 요약

• 주석을 달지않고 의미를 전달하는 것이 가장 좋은 주석이다.
• 불필요한 주석은 혼란만 야기하고 의도, 주의사항 등 꼭 필용한 주석 남긴다.
• 좋은 주석이란 함수명, 메소드명, 클래스명처럼 이름으로 나타내는 것이다.