comments

주석: 컴파일되지 않는 설계 맥락

컴파일러는 주석을 토큰으로 만들지 않지만, 주석은 의도, 단위, 불변식, 예외 사유를 남겨 다음 수정자가 안전하게 판단하게 돕습니다.

컴파일러가 보는 부분과 사람이 읽는 부분

1 #include <iostream> 전처리기가 읽는 include 지시문

2 int age = 30; // 나이를 저장 // 뒤는 토큰이 아니라 설명

3 /* 입력값을 확인한 뒤 출력 */ 불변식, 단위, 예외 사유 기록

good

코드가 이미 말하는 내용보다 도메인 규칙, 단위 변환, 성능 예외를 남깁니다.

avoid

명령문을 한국어로 반복하면 수정 뒤 주석만 과거 로직을 가리키기 쉽습니다.

maintainer hint

주석은 실행 순서를 다시 말하지 않고, 왜 지금 이 구현이 필요한지와 바꾸면 깨지는 계약을 남기는 유지보수 문서입니다.