[노개북 - 6] 4장.주석

TIL (Today I Learned)

2022.02.24

 

오늘 읽은 범위

4장. 주석

 

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

• 잘 달린 주석은 그 어떤 정보보다 유용하다. 경솔하고 근거 없는 주석은 코드를 이해하기 어렵게 만든다. 오래되고 조잡한 주석은 거짓과 잘못된 정보를 퍼뜨려 해악을 미친다. (p.68)
• 주석이 올바른지 검증하기 쉽지 않다. 이것이 의미를 명료히 밝히는 주석이 필요한 이유인 동시에 주석이 위험한 이유이기도 하다. (p.73)
• 주석과 주석이 설명하는 코드는 둘 사이 관계가 명백해야 한다. (p.89)

 

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

• 책에서 소개된 코드를 보고 깜짝 놀랐다! 회사 코드가 딱 그렇게 되어있었다. 심지어 양식까지 거의 유사했다. 이러한 주석을 보면서,, 책에서 말한대로 주석이 수정된 경우가 많이 없었다. 코드는 수정되어있는데 주석은 코드에 맞춰 수정되지 않아 주석은 도움이 전혀 되지 않았고 더 헷갈리기만 했었다.
• 주석을 자세히 다는 것이 능사인 듯 들었으나, 코드 형상 관리 시스템이 있다면 주석은 필요 없을 것 같다는 생각을 했다. 물론, 이름을 잘 지어야지만!!

 

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

•