[공장콩] javascript_@param 태그(@author, @return 등등)

 

 

자바에서의 사용과 다를 수 있음

 

 

 

@param테그는 매개변수에 대한 설명을 표시할 때 사용합니다.

 

유지보수를 쉽게하기 위해 사용합니다.

 

자바에서 @param테그를 사용한 매개변수의 정보는 command창에서 확인할 수 있다고 하네요.

 

 @param테그를 알아보기 전에 자바스크립트 페이지 상단에 기입하면 좋은 속성들 보고 가실게요~!

 

페이지 상단에 넣으면 좋은  파일 설명

 

@fileoverflow : 함수의 반환 값에 대한 설명을 표시 할 때 사용한다.

@author : 해당문서의 작성자

@return  : 함수의 반환 값이 있을 때(한 개 일 때)

@return  : 함수의 반환 값이 있을 때(여러개 일 때)

@version  : 해당문서의 버전

@since : 해당문서의 작성일

 

 

 

 

사용방법

 

/*
 * @param 매개변수명: 매개변수설명
 * @returns
 */​

 

 

/**
 * 함수 설명
 * @param direction : 방향
 * direction 대한 설명 2번째 줄
 * direction 대한 설명 3번째 줄
 * @param width : 폭
 */

 

 

 

 사용예제

 

/*
 * @param direction : 방향
 * @param rowIdx : 현재 테이블 내에서의 row인덱스
 * @param t : this
 */
 function deleteFaq(direction , rowIdx, t){}

 

 

 

이러한 설명을 작성해주면 유지보수 시 쉽게 해당 method나 class를 사용할 수 있도록 api문서로 도출이 가능했다고 하는데 JSDOC 지원이 끝났다고 하네요.

 

 

 

 

 

 

참고 사이트 : https://techbug.tistory.com/110