먼저 정리하기?

14장. 댓글 설명

이 작품은 AI를 사용하여 번역되었습니다. 여러분의 피드백과 의견을 환영합니다: [e-mail]

코드를 읽다가 "아,저게 바로 이거였구나!"라는 생각이 드는 순간을 아시죠? 바로 그 순간이 소중한 순간입니다. 기록하세요.

코드에서 명확하지 않은 내용만 적으세요. 미래의 독자 또는 15분 전의 자신이 되어 보세요. 알았더라면 좋았을 점은 무엇인가요? "다음은 네트워크 호출 횟수를 최대한 줄여야 하므로 복잡합니다."와 같은 메모를 작성할 수 있습니다.

나와 많이 다르더라도 특정한 사람에게 편지를 써보세요. 컴퓨터 과학자로 구성된 팀에서 유일한 생물학자이신가요? 그렇다면 코드에 생물학적 맥락을 설명하는 것이 좋습니다. 아무리 당연해 보이더라도 말이죠. 요점은 다른 사람의 관점에서 생각하고 예상되는 질문을 선제적으로 해결하려고 노력하는 것입니다.

헤더 댓글이 없는 파일을 발견하면 잠재 독자들이 이 파일을 읽는 것이 왜 유용한지 설명하는 헤더를 추가하는 것이 좋습니다. (AllanMertner에게 감사드립니다.)

결함을 발견한 즉시 코멘트를 남기는 것이 좋습니다. 예를 들어 // Be sure to change ../foo if you add another case. 코드에 이러한 결합이 있는 것은 바람직하지 않습니다. 결국에는 이를 제거하는 방법을 배워야 하지만 그 동안에는 커플링 문제를 모래 속에 묻어두는 것보다 커플링 문제를 지적하는 주석을 추가하는 것이 훨씬 낫습니다.