JSDoc

JSDoc 

JSDoc은 javascript 모듈에서 사용되는 각각의 클래스, 함수들에 대한 정의를 

JSDoc에서 정의한 표준 주석양식에 맞춰 작성하게 되면 그에따른 자동화된 개발 래퍼런스 문서가 만들어지게 된다. 

마크다운 문서로 래퍼런스 문서를 제공하여 gitbook 같은 호스팅 서비스에 등재하게 되면 하나의 인쇄물로서 출력도 가능하다.

이러한 방법은 개발자가 일일히 래퍼런스 문서를 만들지 않아도 래퍼런스 문서를 만들 수 있는 이점이 있으며 

표준화된 주석 사용으로 협업 및 인수인계가 원할하게 된다. 사실 다른 Doc 툴도 있지만 해당 서비스가 가장 유력하다.​

https://github.com/jsdoc3/jsdoc​

 

JSDoc​ 샘플링한 문서도 같이 올려봅니다.ㅎ 

 

​test.js 파일 

=============================================​

 

/** This is a description of the foo function. */

function foo() {

}

 

/**

 * Represents a book.

 * @constructor

 */

function Book(title, author) {

}

 

/**

 * Represents a book.

 * @constructor

 * @param {string} title - 제목.

 * @param {string} author - 저자.

 */

function Book(title, author) {

}​ 

=============================================

 

 

 

03.jsdoc.zip