JSDoc의 쓰기, 출력 노트

요즘 자바스크립트를 많이 쓰는데, "스펙 쓰세요!"따라서 JSDc의 기술, 출력 노트.

하고 싶은 일

./src 폴더에 기능별로 저장,module.exports 함수를 설명하고 출력하는 규범

설정

귀찮아서 전 세계에 설치했습니다.

npm install -g jsdoc

견본

작업장 준비

mkdir jsdoc-test
cd jsdoc-test
mkdir src
touch hello.js bye.js

hello.js의 기술

모듈의 경우 @module를 추가하지 않으면 아무것도 출력하지 않습니다.
hello.js

/**
 * Helloという文字列を返します。
 * @module hello
 * @param {string} name - 表示したい名前を指定する。
 * @return {string} - [Hello + name]という形式で戻る。
 */
module.exports = hello = (name) => {
    return "Hello" + name;
}

bye.js의 기술

bye.js

/**
 * Helloという文字列を返します。
 * @module bye
 * @param {string} name - 表示したい名前を指定する。
 * @return {string} - [Bye + name]という形式で戻る。
 */
module.exports = bye = (name) => {
    return "Bye" + name;
}

Doc 출력

jsdoc src

그래서 같은 층에 아웃이라는 폴더를 만듭니다.그중의 index.을 보다.
아래와 같은 내용을 표시합니다.

오른쪽 메뉴의 Hello를 보면 다음과 같은 느낌이 든다.

기본적으로 이상입니다.

어플리케이션 1: Home 화면에 설명문을 추가하십시오.

Mardown으로 설명문을 쓰면 출력할 때 지정하면 가져올 수 있을 것 같습니다.
README.md

### テストAPIです。

以下の２つを作りました。

* hello()
* bye()

그리고 나서

jsdoc src README.md

를 참고하십시오.

적용 2: 설명 Object

JS에서도 Object를 매개 변수로 하고 값을 되돌려 주는 경우가 있다...아래와 같이 서술하다.
object.js

/**
 * Objectを受け取りObjectを返します。
 * @module object
 * @param {Object} user - ユーザーオブジェクト
 * @param {string} user.name - ユーザの名前。
 * @param {number} user.age - ユーザーの年齢。
 * @return {Object} result オブジェクトが戻る。
 * @return {string} result.status - "OK or NG"。
 * @return {string} result.message - メッセージが返ります。
 */
module.exports = object = (User) => {
    return { status: "OK", message: "hoge" }
}

하지만 리턴은 잘 표현할 수 없나요.

적용 3: 템플릿 수정

그런데 왜 JSDoc의 표준 템플릿이 이렇게 미묘할까...적어도 왼쪽 메뉴는 주셨으면 좋겠어요...
방법을 바꾸는 것은 잠시 링크일 뿐입니다.
여기.에 소개된 사이트라서 잠시 적어두겠습니다.