[200제] 07. 주석 Comment

모든 프로그래밍 언어는 코드 설명 혹은 추후 유지보수를 위해 주석(Comment)을 작성을 한다.   
주석은 프로그램의 실행에는 전혀 영향을 주지 않지만, 코드의 가독성을 높이고 협업을 원활하게 하는 중요한 역할을 한다.  
특히, 팀 프로젝트나 오픈소스 개발에서 **좋은 주석**은 필수적이다.

 

✅주석(Comment)이란?

프로그램 소스 코드에 작성하는 메모로, 컴퓨터가 실행 하지 않는 부분

주석은 사람이 코드를 읽고 이해 하기 위해 작성하는 문장.

 

✅Node.js에서 주석 작성법

1. 한 줄 주석
   
   • //로 시작 하며, 해당 줄 끝까지가 주석으로 처리
   • 주로 간단한 설명이나 코드 옆에 설명을 적을 때 사용

// 한 줄 주석

// 이 함수는 두 숫자의 합을 반환합니다.

function add(a, b) {

  return a + b; // a와 b를 더한 값

}

1. 여러 줄 주석
   • /*와 */ 사이에 작성하며, 여러 줄에 걸쳐 설명할 때 사용
   • 주로 함수 설명, 문서화, 임시 코드 차단에 사용

// 한 줄 주석

// 이 함수는 두 숫자의 합을 반환합니다.

function add(a, b) {

  return a + b; // a와 b를 더한 값

}

 

✅주의 

• 주석은 코드와 불일치 하면 오히려 혼란을 줌
• 의미 없는 주석보다 의도를 설명하는 주석 사용 추천
• 너무 많은 주석은 가독성을 해침

---

참고:
본 내용은 「초보자를 위한 Node.js 200제」(김경록님, 정지현님)를 기반으로 하였으며,
본 글은 개인 공부용으로 작성되었으며 상업적 사용은 불가합니다.