한 줄 주석
현재 줄 끝까지 설명을 남깁니다.
// 입력값 검증
주석은 컴파일되지 않는 설명 맥락이다
컴파일러는 주석을 무시하지만, 사람은 주석을 통해 코드의 의도와 주의점을 빠르게 회복합니다.
블록 주석
여러 줄의 배경 설명이나 임시 메모를 묶습니다.
/* 여러 줄 설명 */
컴파일 결과
주석 텍스트는 실행 파일에 포함되지 않습니다.
좋은 주석
왜 이 조건이 필요한지, 어떤 예외를 막는지, 나중에 바꿀 때 무엇을 확인해야 하는지를 남깁니다.
나쁜 주석
코드를 그대로 다시 읽거나, 이미 코드가 말하는 동작만 반복합니다.
유지 기준
코드가 바뀌면 주석도 함께 바뀌어야 합니다. 오래된 주석은 없는 것보다 위험합니다.
주석은 컴퓨터를 위한 문법이 아니라, 미래의 독자를 위한 설계 메모입니다.