[노개북] 클린코드(Clean Code) #04

📌 Assignment #06
📆 2022-04-29(Fri), 2주차
📖 4장. 주석(p.67 ~ p.94)

 

📆 TIL (Today I Learned)

2022-04-29(Fri)

 

📖 오늘 읽은 범위

4장. 주석(p.67 ~ p.94)

 

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

주석은 '순수하게 선하지' 못하다. 사실상 주석은 기껏해야 필요악이다. - p.68

표현력이 풍부하고 깔끔하며 주석이 거의 없는 코드가, 복잡하고 어수선하며 주석이 많이 달린 코드보다 훨씬 좋다. - p.69

 

[좋은 주석]

어떤 주석은 필요하거나 유익하다.

1. 법적인 주석

2. 정보를 제공하는 주석

3. 의미를 명료하게 밝히는 주석

4. 결과를 경고하는 주석

5. TODO 주석

6. 중요성을 강조하는 주석

- p.70~74

 

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

주석 다는 걸 좋아하는 편인데 이 파트를 읽고 반성하게 됐다. 필자는 주석을 거의 혐오하는 수준.

주석을 달지 않아도 쉽게 이해할 수 있는 코드를 짜는 것이 이제부터 나의 목표!

 

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

없음