본문으로 건너뛰기

주석(Comment)

주석(Comment)

주석은 개발자가 코드의 목적, 작동 방식, 변경 사항 등을 설명하거나 특정 부분을 임시로 비활성화할 때 사용합니다.


JavaScript 주석의 종류

  1. 한 줄 주석 (Single-line Comment)

한 줄 주석은 //로 시작하며, 그 라인의 끝까지만 주석 처리됩니다.

주석 활용 예시
// 이 라인은 한 줄 주석입니다
console.log('Hello, World!'); // 이 메시지는 콘솔에 출력됩니다

  1. 여러 줄 주석 (Multi-line Comment)

여러 줄 주석은 /*로 시작하고 */로 끝납니다. 이 주석 스타일은 여러 줄에 걸친 주석을 작성할 때 사용됩니다.

여러줄 주석
/*
이것은 여러 줄 주석입니다.
주석 안의 내용은 실행되지 않습니다.
*/
console.log('Hello, World!');

JavaScript 주석의 활용

  1. 코드 설명: 주석을 사용하여 코드의 기능, 동작 원리, 변수나 함수의 목적 등을 설명할 수 있습니다.
주석으로 코드 설명
// 변수 x에 10을 할당합니다.
let x = 10;

  1. 코드 비활성화: 버그 추적, 디버깅, 또는 특정 코드 조각을 잠시 비활성화하려면 주석 처리를 활용하실 수 있습니다.
특정 코드 비활성화
// console.log("This won't run");

  1. TODO 및 FIXME 표시: 개발 중이거나 수정이 필요한 코드 부분에 주석을 달아 놓으면, 나중에 쉽게 찾아 수정할 수 있습니다. TODO는 앞으로 해야 할 일을 표시할 때, FIXME는 수정이 필요한 부분을 표시할 때 사용합니다.
앞으로 할 일을 표시하는 TODO 주석
// TODO: 여기에 추가적인 기능 구현 필요

주의사항:

  • 주석은 코드 실행에 영향을 주지 않지만, 과도하게 주석을 사용하면 코드의 가독성이 떨어질 수 있습니다. 필요한 부분에만 적절히 주석을 사용하는 것이 좋습니다.

  • 민감한 정보나 불필요한 개인적인 내용은 주석에 포함시키지 않는 것이 좋습니다.