주석 (Comments)

자바스크립트에서의 주석은 대부분의 프로그래밍 언어와 유사한 방식으로 사용할 수 있다. 보통 한줄 주석이나 여러 줄 주석이 있으며 한줄 주석은 // 뒤에, 여러줄 주석은 /*와 */ 사이에 텍스트를 남긴다.

// This line is a comment.
console.log('Hello'); // 'Hello'

/* This line is a comment.
 *
 * This part of the code is also not executed.
 * function Main () {
 *   console.log('Hello');
 * }
 *
 * Main();
 *
 * */

주석과 텍스트 사이에는 공백이 들어가는 것이 좋다.

주석은 실행되는 코드가 아니기 때문에 여러가지 목적으로 활용된다.

• 알기 쉬운 코드 이해를 위한 설명을 위해
• 테스트용으로 잠시 특정 코드의 실행을 방지하기 위해

일부 IDE에서는 특수한 포맷으로 작성된 주석을 해석하여 정리하므로 여러 용도로 활용할 수 있다. 예를 들어 다음과 같이 사용한다.

function Main() {
	// TODO: Write the Main function
}

TODO: (공백으로 구분)를 붙여 작성하면 IDE는 할일 목록에 해당 라인의 코드를 바로가기 할 수 있는 리스트를 생성한다. 이외에도 여러가지 포맷들이 있다. (IDE마다 처리 방식이 다를 수 있으며 이 것이 공식적인 것은 아니다.)

• TODO: 추후 동작에 있어 작성이나 수정이 필요한 부분
• NOTE: 코드가 동작하는데 유의할 점이나 명확하지 않은 동작에 대한 참고사항
• FIXME: 해당 코드에 대한 검토 및 재작성이 필요함
• BUG: 해당 코드에 문제가 있음
• XXX: 확실하지 않거나, 수정이 필요하거나, 완료되지 않은 부분

일반적으로 자바스크립트 주석은 외부에 노출되기 때문에 중요한 코드는 주석에 포함하지 않는 것이 좋다. (컴파일러에 따라 주석을 알아서 제거해주기도 한다.)

매 코드 줄 마다 주석을 달아 설명하는 것 보다는 이해가 필요하거나 복잡한 로직을 처리하는 부분에 명확하게 작성하는 것이 바람직하다.