summary of chapter 4 in CLEAN CODE

1. CLEAN CODE

2. 코드는 시간에 따라 변하는 함수지만, 주석은 상수다. 코드가 나쁘면 주석을 달고 싶은 욕망이 생긴다. 하지만 코드를 정리하는 것이 낫다.

3. // 직원에게 복지 혜택을 받을 자격이 있는지 검사한다. If((employee.flags & HOURLY_FLAG) && (employee.age > 65)) /*…*/ vs If(employee.isEligibleForFullBenefits()) /*…*/ 코드로 의도를 표현하라!

5. 정보를 제공하는 주석

6. 의도를 설명하는 주석

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

8. 결과를 경고하는 주석

9. todo주석

11. 같은 이야기를 중복하는 주석

12. 오해할 여지가 있는 주석

13. 의무적으로 다는 주석

14. 이력을 기록하는 주석(이제는 소스 제어 시스템에게 맡기자)

16. 함수나 변수로 표현이 가능한데 달린 주석

17. 위치를 표시하는 주석

18. 닫는 괄호에 다는 주석

19. 공로를 돌리거나 저자를 표시하는 주석

21. 전역 정보에 대한 주석

22. 너무 많은 정보를 보여주는 주석

23. 주석 자체에 설명이 필요한 주석

24. 함수 헤더 주석