주석 (프로그래밍)

Comment; 주석
소스 코드 안에 사람이 읽으라고 적어 두는 설명문으로, 컴파일러나 인터프리터가 번역할 때 무시하는 부분

개요

주석은 프로그램의 동작에 아무 영향을 주지 않는다. 번역 단계에서 컴파일러나 전처리기가 지워 버리므로 실행 파일에도 남지 않는다. 대신 코드를 읽는 사람에게 이 함수가 무엇을 하는지, 왜 이렇게 짰는지, 어떤 입력을 기대하는지를 알려 준다. 그래서 주석은 코드 해석을 돕고 프로그램 문서화의 중요한 부분이 된다. 주석을 다는 기호는 언어마다 다르지만 거의 모든 프로그래밍 언어가 주석을 허용한다.

언어별 형식

언어	한 줄 주석	여러 줄 주석
C, C++, Java, JavaScript	`// 설명`	`/* 설명 */`
Python	`# 설명`	따로 없음. 문서화 문자열 `""" 설명 """` 을 쓴다
셸 스크립트, Perl, Ruby	`# 설명`
SQL	`-- 설명`	`/* 설명 */`
HTML, XML		`<!-- 설명 -->`
BASIC	`REM 설명`, `' 설명`
COBOL	7번째 칸의 `*`

주석과 헷갈리는 구문 요소

변수 - 프로그램이 동작하는 동안 값이 바뀔 수 있는 기억 장소에 이름을 붙여 추상화한 것. 주석은 기억 장소를 차지하지 않는다
상수 - 실행 중 값이 바뀌지 않는 이름이나 값
식별자·예약어 - 변수·함수에 붙이는 이름과 언어가 미리 정해 둔 단어. 주석 안의 글자는 식별자로 해석되지 않는다

좋은 주석

코드가 무엇을 하는지보다 왜 그렇게 하는지를 적는다
코드를 고치면 주석도 함께 고친다. 코드와 어긋난 주석은 없는 것보다 해롭다
함수·클래스 머리에 문서화 주석(Javadoc /** */, Python docstring)을 달면 도구가 API 문서를 만들어 준다
비밀번호·서버 주소 같은 중요 정보를 주석에 남기지 않는다. 소스가 유출되면 그대로 드러난다(시큐어 코딩의 '주석문 안에 포함된 시스템 주요정보')

같이 보기