자바스크립트 한 줄 주석과 여러 줄 주석 및 코드 가독성 예제


자바스크립트 주석은 코드를 설명할 때 사용하는 부가 기능입니다. 한 줄 주석은 // 기호를 사용합니다. 여러 줄 주석은 /**/ 기호를 사용하며 서로 중첩을 불가능합니다.

자바스크립트 한 줄 주석

자바스크립트 코드에서 한 줄 주석 기호는 // 입니다.


document.write("Hello World!");   //한 줄 주석

각 줄마다 주석을 따로 삽입할 수 있습니다. 주석은 사람 눈에만 인식되고 컴파일러는 무시합니다.

//주석은 사람만 인지합니다.

var a = 1;             //a에 1 저장
var b = 2;             //b에 2 저장

document.write(a+b);   //a + b 출력

자바스크립트 여러 줄 주석

여러 줄 주석 기호는 /**/ 입니다. /**/ 사이에 주석을 입력하면 됩니다.

/*여러 줄 주석
기입한 값의
줄바꿈이
유지됩니다.*/

var x = 2;
var y = 4;

document.write(x+y);

여러 줄 주석 중첩 불가

여러 줄 주석은 서로 중첩이 안되니 유의합니다. /* /* */ */와 같은 방식으로 주석 작성시 가장 처음 만나는 */ 닫는 기호에서 주석이 종료됩니다.


var x = 2;
document.write(x);

/*여러 줄 주석은 중첩이 안됩니다. 
/*닫는 주석 기호가 둘 이상 있을 경우*/ 
가장 처음 만나는 닫는 주석 기호에서 
바로 주석 처리 됩니다.*/

주석 삽입과 코드 가독성

주석을 적지 않으면 코딩에서 인간은 변수명, 들여쓰기, 띄어쓰기, 줄바꿈 등의 요소로만 가독성을 얻을 수 있습니다. 컴퓨터 코드가 어려운 이유는 이진법인 기계어와 인간 언어의 중간을 담당하는 매개체이기 때문입니다.

<script>
  var num1;
  var num2;
  var result;

  num1 = prompt("정수를 입력하세요.", "");
  num2 = prompt("정수를 입력하세요.", "");

  num1 = Number(num1);
  num2 = Number(num2);

  result = num1 + num2;
  document.write(result);
</script>

주석(인간 언어)을 적절히 삽입하면 프로그래밍 언어의 가독성을 늘릴 수 있습니다.

<script>
  /*자바스크립트 데이터 입력 및 연산 출력 코드*/

  //변수 선언
  var num1;           //변수 1
  var num2;           //변수 2
  var result;         //결과

  //변수값 입력
  num1 = prompt("정수를 입력하세요.", "");
  num2 = prompt("정수를 입력하세요.", "");

  //자료형 변환
  num1 = Number(num1);
  num2 = Number(num2);

  //변수값 연산 및 출력
  result = num1 + num2;
  document.write(result);
</script>

코드가 길어질 수록 주석이 없다면, 차후 편집이 쉽지 않을 것입니다.