성능, 보안, 호환성 같은 선택 이유를 남깁니다.
좋은 주석 판별표
주석은 코드가 무엇을 하는지 반복하기보다 왜 그렇게 했는지를 남길 때 가치가 있습니다.
코드로 보이지 않는 의사결정을 설명하는가
공개 API는 문서 주석으로 사용법과 전제를 설명합니다.
코드와 같은 말을 반복하는 주석은 유지보수 비용만 늘립니다.
문서 예제는 가능한 한 실행 가능한 형태로 유지합니다.
주석은 코드가 무엇을 하는지 반복하기보다 왜 그렇게 했는지를 남길 때 가치가 있습니다.
코드로 보이지 않는 의사결정을 설명하는가
성능, 보안, 호환성 같은 선택 이유를 남깁니다.
공개 API는 문서 주석으로 사용법과 전제를 설명합니다.
코드와 같은 말을 반복하는 주석은 유지보수 비용만 늘립니다.
문서 예제는 가능한 한 실행 가능한 형태로 유지합니다.