코드 주석

정의

코드 중간에 사람이 읽을 수 있게 남겨 두는 설명 글.

자세한 설명

코드 실행에는 영향을 주지 않으면서, 그 옆이나 위에 이 부분은 왜 이렇게 짰다는 설명을 사람이 읽을 수 있게 남겨 두는 글입니다. 복잡하거나 특이한 이유로 짜인 부분에 주석을 남겨 두면, 나중에 다른 사람이나 에이전트가 그 코드를 볼 때 왜 그렇게 짜였는지 바로 이해할 수 있습니다. 당연한 내용까지 일일이 적으면 오히려 코드를 어지럽게 만들 수 있습니다.

예를 들면

세금 계산 방식이 법 기준과 달라 특이하게 짜인 부분에, 왜 그렇게 짰는지 코드 주석으로 남겨 뒀습니다.

관련 용어