comment
-
소스코드 주석(comment)에 대한 짧은 글Think 2023. 3. 5.
위키피디아에 의하면 주석이란 소스 코드를 더 쉽게 이해할 수 있게 만드는 것이 목적인 메모를 말한다. 주석 또는 코멘트는 프로그래밍에 있어 내용을 메모하는 목적으로 쓰인다. 소스 코드를 더 쉽게 이해할 수 있게 만드는 것이 주 목적이며, 협업할 때 유용히 쓰인다. 컴파일러와 인터프리터에 의해 일반적으로 무시되어 프로그램에 영향을 주지 않는다. 위키백과 하지만 주석 때문에 소스코드를 더 이해하기 어려울 수 있다. 예를 들어, 1. 코드의 의도가 명백하여 오히려 주석이 중복 내용에 가깝다. "XX를 출력합니다, XX를 가져옵니다. XX를 처리하고 응답합니다."등이 있다. 2. 주석이 관리가 되지 않아 소스코드의 내용과 전혀 다른 설명을 하게 된 경우이다. 너무나도 슬픈 사실인데 소스코드를 수정하는 사람이 주..