tidy first 15장 '불필요한 주석 지우기' 를 읽고

불필요한 주석과 불필요해진 주석

가치가 낮은 주석을 크게 두 가지로 나눌 수 있다고 생각 했습니다.

1. 불필요한 주석
   • 코드만으로 충분히 이해할 수 있는 내용을 중복 설명하는 주석
2. 불필요해진 주석
   • 복사, 붙여 넣기 또는 코드 변경으로 인해 더 이상 유효하지 않게 된 주석
   • 오해의 소지가 있어 코드 이해를 방해

주석이 애플리케이션 코드 동작에 직접적인 영향을 주지 않지만, 가독성과 유지보수에 큰 영향을 미칠 수 있기 때문에 엄격하게 관리 될 필요가 있다고 생각 했습니다.

 

도메인에 대한 이해

주석의 가치를 올바르게 판단하기 위해서는 서비스 도메인에 대한 깊은 이해가 선행되어야 합니다. 이것은 단순히 기술적인 관점에서 코드를 이해하는 것을 넘어, 그 코드가 왜 필요한지 안다는 것을 의미합니다.

서비스 도메인에 대해 깊이 이해하면 다음과 같은 이점이 있습니다.

1. ‘왜 해야 하는지’, ‘무엇을 하려고 하는지’ 알기 때문에 서비스의 가치를 지킬 수 있다.
2. 해결하고 싶은 것이 무엇인지 알기 때문에 문제에 집중할 수 있다.
3. 기존의 해결 방법에 얽매이지 않고, 새로운 해결 방법을 도출할 수 있다.
4. 타 부서 사람들(ex, 기획자)과 의사소통 과정에 오해를 줄일 수 있다.