코드에 메모하는 법 - 주석(Comment)

주석은 코드 내에 작성하는 메모라고 생각하면 된다.

주석 처리된 부분은 프로그램이 해석하지 않는다.

사용자와 프로그램에겐 노출되지 않는 부분,

즉, 개발자들을 위한 장치인 것이다.

 

프로그램이 클 수록 코드를 알아보기가 어려워진다.

특히 협업하는 경우, 주석으로 다른 개발자들을 도와줄 수 있다.

다른 개발자뿐만 아니라, 자신에게도 마찬가지다.

예를 들어, 테스트 코드나 임시로 작성된 코드가 있을 때, 이걸 주석으로 알려주면 좀 더 빠르게 코드를 이해할 수 있을 것이다.

 

프로그래밍 언어마다 주석 처리하는 방법이 조금씩 다르다.

 

아래로 HTML, CSS, JavaScript, Java의 주석 처리 방법에 대해 정리하였다.

 

 

 

1. HTML

 

HTML은 다음과 같이 주석을 처리한다.

<!-- 주석 처리할 내용 -->

 

<!-- 로 주석을 시작하고, -->로 닫는다.

이 사이에 들어가는 내용은 모두 주석 처리된다.

다음과 같이 여러 줄로 된 내용도 주석 처리할 수 있다.

<!--

  개행된 내용도 모두 주석 처리!

-->

 

 

 

2. CSS

 

CSS의 주석 처리는 다음과 같다.

/* 주석 처리할 내용 */

 

슬래쉬, 별로 열고, 별, 슬래쉬로 닫는다.

 

HTML 주석과 마찬가지로 다음처럼 여러 줄의 데이터도 주석 처리할 수 있다.

/*
  여
  러
  줄
*/

 

 

 

3. JavaScript

 

자바스크립트의 주석은 다음과 같다.

// 주석 처리할 내용

 

슬래쉬 두개로 주석 처리를 한다.

 

HTML, CSS는 두 주석 태그 사이의 데이터가 주석 처리되었지만,

자바스크립트는 // 뒤의 내용을 모두 주석 처리한다.

 

또한 여러 줄을 주석 처리하는 방법은 3가지가 있다.

// 슬래쉬 슬래쉬를 각 줄마다
// 넣어주면
// 모두 주석 처리된다.


/*
  CSS와 같은 모양
*/

물론 /*이렇게 한 줄로도 가능하다*/


/*
* 이런 모양으로 주석을
* 처리하기도 한다.
*/

 

 

 

4. Java

 

자바 코드에서 주석을 처리하려면 다음과 같이 하면 된다.

// Java 주석

 

여러 줄은 다음과 같다.

// JavaScript처럼 한줄 주석을
// 여러번 써서
// 여러 줄을 주석 처리할 수 있다.

/*
  이 주석 역시
  JavaScript, CSS와 동일하다.
*/

 

다음에 소개할 주석은 '문서 주석'이라고 한다.

자바 코드를 문서화할 때 읽히는 주석이다.

/**
*문서 주석 소개하는 API입니다.
*
*@author enai
*@param type 선택한 언어
*@return type이 Java라면 true, 그 외엔 false를 반환한다.
*@version 1.0
*/

 

이런식으로 태그를 이용하여 해당 API를 설명하는 주석을 달 수 있다.

JavaDoc(java programming document)를 만들 때, 위와 같은 태그의 내용들을 넣을 수 있다.

(JavaDoc은 자바 API를 설명하는 HTML 문서를 생성해주는 도구이다.)

JavaDoc과 관련된 더 많은 태그가 있지만, 본 글의 주제에서 조금 벗어나므로 패스한다.

 

 

 

 

 

 

 

 

출처: https://enai.tistory.com/46