JS 주석 달기

02/28

 

 

뭐 별건 아니고, JS 에서 주석을 다는 방법을 정리해보자.

 

1. 한줄 주석

// 한 줄 주석을 달 때
중간부터     // 주석처리하면 거기부터

js에서 한 줄 주석을 다는 것은 간단하다.
// 가 붙어있으면, 줄 앞이든 중간이든 상관 없이 그곳부터 주석처리된다.
나는 vsc에서 ctrl + / 로 단축키 지정하여 매우 자주 사용중.

 

2. 여러 줄 주석

/* 여러 줄 주석을 달 때는
   시작 부분과 끝 부분에만 있으면 된다.
*/

여러 줄을 한번에 주석처리 할 때는,
/* 로 열고 */ 로 닫으면 중간 부분들이 전부 주석 처리 되는데, 나는 자주 쓰지는 않는편.
그냥 여러줄 선택해서 // 하는게 편하긴 하다. 뭐가 더 좋은 방법인지는 모르겠음.

 

3. 함수 주석 문서화 (JSDoc)

오늘 이 글을 쓰게 된 목적...

/**
* a숫자와 b문자가 같은지 확인한다.
*
* @param {number} param_a 확인하려고 하는 number가 들어와야 합니다.
* @param {string} param_b 확인하려고 하는 string이 들어와야 합니다.
* @return {boolean} 같다면 true, 다르면 false를 반환합니다.
*/
function(param_a: number, param_b: string) {
	return param_a.toString() === param_b;
}

위와 같은 주석 문법을 JSDoc 라고 한다.
JSDoc은 자바스크립트 API 문서 생성기로, 자바스크립트 코드에 이와 같은 형식의 주석을 넣으면
API를 설명하는 HTML 문서를 생성할 수 있다.
JSDoc 주석은 /** */ 를 사용하기 때문에 일반적인 /* */ 은 무시됨.

함수, 각 파라미터, 반환값에 대한 설명과 사용 예시를 주석으로 추가할 수 있다.

이걸로 새로 만든 바로가기 함수에 주석을 추가해놨따...
이러면 다음 구현때 담당자 안 찾고 직접들 구현 하시는거 맞죠..? 아님말고