Part 5. 주석에

Part 5

주석에 담아야 하는 대상

주석을 잘 쓰지 않는다.

그렇게에 더 열심히 읽어보자.

설명하지 말아야 하는 것.

코딩을 수행하면서 머릿속에 있는 정보를 기록하기.

코드를 읽는 사람의 입장에서 필요한 정보가 무엇인지 유추하기.

책에서는 간단한 이야기로 정의를 해두었다.

. 나쁜 이름에는 주석을 달지 마라 - 대신 이름을 고쳐라

. 생각을 기록하라 - (예/ 빠르다 무엇 때문에)

. 코드의 결함을 설명하라 - TODO 개선 아이디어

. 상수에 대한 설명 (오해가 생기지 않게)

. 세부 사항을 설명하여 예측하자 (예/ 1분 이후 타임아웃)

읽기 좋은 코드가 좋은 코드다.

더스틴 보즈웰, 트레버 파우커 지음 - 임백준 옮김

한빛미디어