[javascript] 코드 주석 추가
JavaScript 코드 주석은 코드를 이해하고 유지 보수하는 데 도움이 되는 중요한 도구입니다. 주석을 추가하여 코드의 기능, 작동 방식, 또는 특정 부분에 대한 설명을 제공할 수 있습니다. 이 문서에서는 JavaScript 코드에 주석을 추가하는 방법을 알아보겠습니다.
1. 한 줄 주석
한 줄 주석은 //
으로 시작하며 해당 라인의 끝까지 유효합니다.
// 이것은 한 줄 주석입니다.
let num = 5; // 변수에 값을 할당합니다.
2. 여러 줄 주석
여러 줄 주석은 /*
로 시작하여 */
로 끝납니다. 이 주석은 여러 줄에 걸쳐 사용할 수 있습니다.
/*
여러 줄 주석의 예시입니다.
여러 줄에 걸쳐 설명을 추가할 수 있습니다.
*/
let name = "John";
3. 주석의 활용
- 코드 설명: 코드의 기능이나 작동 방식에 대한 설명을 추가합니다.
- 작업 계획: 특정 부분의 수정이나 추가 작업을 계획하는 주석을 추가할 수 있습니다.
- 임시 코드: 기존 코드를 주석 처리하여 임시로 작동하지 않도록 할 수 있습니다.
JavaScript 코드 주석은 가독성을 높이고 코드 이해를 돕는 데 중요한 역할을 합니다. 적절한 주석을 추가하여 코드의 가독성을 향상시키세요.
더 많은 정보를 원하시면 MDN web docs를 참고하세요.