[2주차] Clean_Code_3-4장_정원영
Closed this issue · 4 comments
4장 주석에 관련해서 읽다가 의문점이 생겼습니다.
저자는 좋은 주석과 나쁜 주석을 나누어 설명을 진행하며 몇몇 좋은 주석은 시간이 흐름에 따라 결국 나쁜 주석이 된다고 말하고 있습니다. 주석을 다는 노력을 대신해 코드로 의도를 명확히 나타내는 것이 최선의 방법이지만, 만약 주석을 남기게 되었다면 오래된 주석이 나쁜 주석으로 변질되는 과정을 예방하기 위해서는 어떤 방법이 있을까요 ?
'오래된 주석이 나쁜 주석으로 변질되는 과정'이 정확하게 어떤 상황인지 궁금합니다.!
제 생각엔 안좋은 주석은, 작성자가 주석을 달게 된 즉시 나쁜 주석이 되는 것 같아서요,!
따라서 명확한 '시간이 지날수록 나쁜 주석'이라는 개념에 대한 정의가 궁금합니다.
제 질문이 미흡했던 것 같습니다 !
p68에 "주석은 오래될수록 코드에서 멀어진다. 오래될수록 완전히 그릇될 가능성도 커진다. 프로그래머들이 주석을 유지하고 보수하기란 현실적으로 불가능하니까" 이 부분에서 저자가 말한 좋은 주석을 달더라도 시간이 흐름에 따라 코드에서 멀어지며 나쁜 주석이 될 수 있다고 생각했습니다.
"의미를 명료하게 밝힌 주석"도 시간이 흐름에 따라 코드와 멀어질 것이라 생각이 들었습니다. 결국 주석을 코드로 설명할 수 있게 만드는 방법이 최선이지만, 혹시 주석을 관리할 수 있는 방법이 없을지.. 라는 생각이 들어서 질문했습니다 !
오래된 주석은 변경사항이 있는 코드를 따라가지 못해서 그런게 아닐까 싶은데 그러면 코드를 변경했을 때 주석도 맞춰서 변경돼야 한다고 생각합니다.
주석도 찾아보면 관리하는 시스템이 있지 않을까 싶어 찾아 봤는데 없네요 허허
저자가 좋은 주석의 TODO 주석을 설명할때 이렇게 언급했습니다.
TODO 주석
필요하다 여기지만 당장 구현하기 어려운 업무를 기술. → 주기적으로 점검해 없애도 괜찮은 주석은 없앨것.
가령 TODO뿐만 아니라 다른 주석들도 주기적으로 점검해 없애도 괜찮은 주석을 없앤다면 유지보수가 조금이나마 되지 않을까 합니다!
1장에 나온 코딩 보이스카운트 1규칙을 적용하는것도 좋겠네요!
코드는 처음 읽을때보다 더 깨끗하게 해놓고 떠나라. -> 주석도 적용된다.