자바스크립트 튜토리얼 4 | 주석문 사용하기

주석문(Comments)은 프로그램의 실행에 영향을 미치지 않는 텍스트이다.

주석문을 컴파일러나 인터프리터가 해석하지는 않는다.

그런 내용을 왜 소스코드에 적는 낭비를 하는가?

*일단 코드의 작성자가 내용을 기억하기 위해서 이다.

-> 코드를 쓰는 사람의 입장에서 자신이 쓴 코드를 1년 뒤에 다시 보는일이 생길 수 있다. 1년전에 작성한 코드는 잘 기억이 나지 않는다. 변수 규칙이나 메서드의 이름을 잘 지어두면 될 것 같지만 보통 사람에게는 기억력의 한계가 있다.

주석문을 써둔다면 분명 기억나지 않는 코드의 실마리를 풀 수 있는 도움을 받을 것이다.

*다른 이유로는 코드를 타인에게 전달하기 위해서 이다.

- > 개발자로써 항상 자신이 작성한 코드만 다루지 않는다. 오히려 타인이 설계하고 구현한 소스코드를 수정하는 일을 더 많이 할 수도 있다. 코드가 자신의 것이 아니라 회사나 공기관의 자산인 경우 더 필요하다. 직원은 회사를 퇴사할 수도 있고 혹은 다른 부서나 직원에게 코드를 인수인계 해줘야 할 때도 있다.

만약 구현한 사람이 무책임하게 아무 정보도 남기지 않고 코드를 전달한다면 코드를 유지 보수하는게 어려워질 것이다. 시간이 없어서 일이 너무 많아서 주석 처리를 제대로 못했다는 말은 현실에서 들을 수 있는 이야기지만 주석을 이해하기 어렵게 써놓은 것도 비슷한 경우다. 따라서 보편적으로 알아들을 수 있는 주석의 첨가가 필요하다.

*씹어먹는 C언어의 저자에 따르면 윈도우 XP의 소스코드는 4000만줄 정도 된다고 한다. 운영체제라는 것은 아마 세상에서 가장 복잡한 컴퓨터 프로그램중의 하나 일 것이다. 말 그대로 이 복잡한 기계를 운영하는 시스템이므로 그만큼 소스코드도 길다.

4000만 줄의 코드는 빌게이츠도 기억못한다. 거기에는 수많은 사람들의 주석이 달려있고 하나의 프로그램에는 API 문서와 메뉴얼이 같이 만들어 진다. 그렇기에 그렇저럭 유지가 되는 것이다. 예전에는 윈도우 파란화면을 자주 봤었는데 지금은 별로 못본다. 윈도우의 버전이 올라가면서 관리 시스템도 향상된 것이다. 주석은 관리시스템에 필요한 하나의 도구이다. 이게 전부는 아니지만 프로그램의 입문 단계에서는 중요한 역할을 한다. 특히 타인의 코드를 분석할 때 주석이 있으면 좀 더 수월하게 읽을 수 있다. 그런데 주석을 다는 것도 다 시간과 노력이 필요한 일이므로 개인 프로젝트에는 적당히 조절이 필요하다.

그러면 자바스크립트의 주석을 한번 알아보자. 특수문자 //, /* */ 를 사용하는데 이것은 C언어 스타일이다.

한줄은 //

여러줄은 /* 열고 */ 닫는다.

비주얼 스튜디오 코드에서는 [컨트롤] + / 단축키를 사용할 수 있다. 단축키가 꽤 유용하다.

<!DOCTYPE html>
<html lang="ko">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>Document</title>
</head>
<body>
        <h1>[자바스크립트 튜토리얼]</h1>
    <script>
        // 한줄 주석입니다.
        var a = 3;
        var b = 5;
        /* 여러줄 주석입니다.
        중간도 주석처리한다.
        */
        document.write(" a + b 는? a = 3, b = 5 -> " + "<h2> 답은 " + (a+b) + "</h2>"); 
        document.write("주석은 안보여요~!"); 

        // Ctrl + D 단축키를 사용합니다.

        // document.write("단축키를 사용해보자. 컨트롤 + 디 ")
    </script>
</body>
</html>