[Clean Code] TIL - Day 09

Clean Code TIL Day 09

Day 09

🔖 오늘 읽은 범위 :  4장 주석 (p.83~p.94)

---

😃 책에서 기억하고 싶은 내용

• 함수나 변수로 표현할 수 있다면 주석을 달지 마라.(p.84)
• 소스 코드 관리 시스템은 누가 언제 무엇을 추가했는지 귀신처럼 기억한다. 저자 이름으로 코드를 오염시킬 필요 없다.(p.86)
• 주석으로 처리한 코드만큼 밉살스러운 관행도 드물다.(p.86)
• 소스 코드 관리 시스템이 우리를 대신해 코드를 기억해준다. 이제는 주석으로 처리할 필요가 없다. 그냥 코드를 삭제하라. 잃어버릴 염려는 없다. 약속한다.(p.87)
• 주석을 달아야 한다면 근처에 있는 코드만 기술하라. 코드 일부에 주석을 달면서 시스템의 전반적인 정보를 기술하지 마라.(p.88)
• 주석에다 흥미로운 역사나 관련 없는 정보를 장황하게 늘여놓지 마라.(p.88)
• 주석과 주석이 설명하는 코드는 둘 사이 관계가 명백해야 한다.(p.89)
• 짧은 함수는 긴 설명이 필요 없다. 짧고 한 가지만 수행하며 이름을 잘 붙인 함수가 주석으로 헤더를 추가한 함수보다 훨씬 좋다.(p.89)

🤔 오늘 읽은 소감과 떠오르는 생각

4장 주석을 끝 마쳤다. 주석을 최대한 지양하되 어느 때 유용하게 사용할 수 있는지 전반적으로 머릿속에 그림이 그려졌다. 나는 읽으면서 당연하다고 생각했던 내용들이 많아서 이번에도 '내가 잘 하고 있었던 건가' 하는 생각이 들었다.

그래도 자만하지 않고 책에서 전수 해주는 내용을 다시금 생각 하면서 다음에 개발을 할 때 실수 하지 않도록 해야겠다.

🔎 궁금한 내용이 있거나, 잘 이해되지 않는 내용

x

소감 3줄 요약

• 함수나 변수로 표현할 수 있다면 주석을 달지 마라.
• 주석으로 처리한 코드만큼 밉살스러운 관행도 드물다.
• 주석과 주석이 설명하는 코드는 둘 사이 관계가 명백해야 한다.