자바스크립트 코드를 문서화하는 방법 JSDoc

자바스크립트 코드를 문서화하는 방법 JSDoc

반응형

Photo by Scott Graham on Unsplash

타입스크립트로 개발을 하다 보면 아래와 같은 주석 코드를 보게 됩니다.

/** * @constructor * @param {number} data */

타입스크립트에서 이러한 설명 주석을 사용할 수 있는 이유는 JSDoc을 지원하기 때문인데요. 이번 글에선 JSDoc이란 무엇인지와 어떻게 사용하는지 소개해보려고 합니다.

JSDoc이란 JavaScript 소스 코드에 대한 설명을 하기 위해 사용되는 마크업 언어입니다.

JSDoc은 마크업 언어라고 소개하였는데요. 즉 태그를 이용하여 문서의 구조를 명기하는 것을 알 수 있습니다.

HTML의 경우 태그는 꺽쇠 기호(<>)를 사용하여 태그를 표현하지만 JSDoc의 경우 @을 사용하여 태그를 표현합니다.

처음에 보여드린 예시처럼 @constructor 와 같은 형태로 태그를 사용하는 것을 알 수 있습니다.

JSDoc에서 지원하는 태그는 block tag와 inline tag로 나눠지는데요. 사용 문법이 약간 다릅니다.

@alias(block tag)와 @link(inline tag) 태그로 차이점을 확인해보면:

Block tag

/** * Bar function. * @alias bar */ function foo() {}

Inline tag

/** * See {@link MyClass} and [MyClass’s foo property]{@link MyClass#foo}. * Also, check out {@link http://www.google.com|Google} and * {@link https://github.com GitHub}. */ function myFunction() {}

HTML의 block tag, inline tag와 비슷하게 주석 안에서 한 줄을 차지하느냐(block tag) 주석 안의 다른 설명 안에 속하느냐(inline tag)에 따라 다른 것을 확인할 수 있습니다.

대부분의 태그들의 경우 block tag 이며 inline tag는 @link 와 @tutorial 뿐입니다.

반응형

from http://clap-yeon.tistory.com/88 by ccl(A) rewrite - 2021-12-02 18:27:52