주석이란 , 주석처리 하는방법

주석을 처음 들으면 무슨 보석같은건줄 알겠지만

주석은 코드를 편집할때 이 코드(줄)이 무슨 기능을 하는지

다른사람들에게 알리기 위해서 또는

오랜기간 후에 코드를 수정해야할때

이 코드가 무슨 기능이였는지 알기 위해서

적는 일종의 설명하는 글이다.

 

주석은 1인개발자일때 알아도 쓰지 않는경우가 많은데,

당장은 프로젝트의 코드를 미래에 볼일이 별로 없고,

내가 쓴 코드는 내가 안다고 생각할지 모르지만

 

나중에 회사생활을 할때라도 상대방을 위해서

주석을 적어주는게 좋다.

 

주석을 쓰는 방법은 기본적으로 두가지인데,

한줄 전체를 감싸고 싶을때는

//Code.tistory.blog();

이렇게 앞에 /를 두개 붙여줘서 // 이런식으로 만들어주고,

여러줄을 감싸고 싶을때는

/*
code.tistory.blog();
code.naver.blog();
*/

이렇게 /* 과 */ 사이에 코드를 적어주면 무효가 되면서 주석처리된다.

 

사용법은 이렇게 쉬운데,

여기서 조금더 나아간, 

좀더 전문가스럽고, 

유용한 주석이 있다.

 

그것은 JSDoc이라고 부르는

/** Code */

이렇게 쓰는 방법이다.

 

이렇게 주석을 쓰면, 사람이 볼수있을 뿐만 아니라

에디터에서 저 주석 아래의 변수나 함수에

설명을 자체적으로 추가한다.

글로만 봐서는 이해가 안될테니 사진을 보여주겠다.

/** 만든사진 */
 var picture = document.createElement('img')

이렇게 javaScript에서 picture을 선언해주면,

에디터에서

이렇게 자동완성을 할때, 자신이 주석처리한 부분이 옆에 뜬다.

이로서 다른이가 만든 함수를 사용할때 더 쉽게 이용할수있다.

 

여기까지 주석를 쓰는 이유, 쓰는방법,

심화까지 알아보았다.

 

도움이 되었길 바라며,

다른언어에서는 안되는경우가 있는데,

확장팩을 깔면 된다.

 

끝.