클린 코드 작성

5. 주석에 담아야 하는 대상

이 글은 읽기 좋은 코드가 좋은 코드다(더스틴 보즈웰, 트레버 파우커 지음 / 임백준 옮김 / 한빛미디어) 를 읽고 내용을 정리한 글입니다. 1. 설명하지 말아야 하는 것 -> 코드에서 빠르게 유추할 수 있는 내용은 주석으로 달지 않는다. -> 주석을 달 때는 실제 주석이 도움될지를 고민해보고 달아라. -> 이름이 애매하다면 주석으로 설명할 것이 아니라, 이름 자체를 수정해야한다. -> 좋은 코드 > 나쁜 코드 + 주석 2. 생각을 기록하라 -> 코드를 짜면서 얻게된 중요한 통찰을 주석으로 기록하여, 읽는이가 헷갈리지 않도록 하라 TODO 해야할 일 FIXME 오동작을 일으킨다고 알려진 코드 HACK 좋지 않은 해결책 XXX 위험! TestMate ESC -> 상수에도 주석을 붙이면 의미가 더 뚜렷해진다..