jsdoc3

3열

1답변

@JSDoc을 사용하여 자바 스크립트 라이브러리의 문서를 만듭니다. 선택적 매개 변수를 나타내는 방법을 알고 있습니다. like below /* * @param {string} [somebody] - Somebody's name. */ function sayHello(somebody) { if (!somebody) { somebod

0열

1답변

JSDoc : 탐색 모음에 기능을 추가하는 방법

jsdoc 기본 템플리트에서 탐색 막대는 publish.jsbuildNav 함수로 구성됩니다. nav += buildMemberNav(members.events, 'Events', seen, linkto); 그러나, members.functions 없습니다. 탐색 모음에서 모든 네임 스페이스, 클래스 아래에있는 모든 함수를 나열하는 방법을 알고 싶습니다.

0열

1답변

JSDoc : 노드, 이벤트, 리스너

JS/NodeJS로 작성된 매우 광범위한 (나에게) 코드 기반을 문서화하려고합니다. JSDoc은 유일하게 유효한 도구로 보이지만 문제가 있습니다. 여기에 내가 문서화하는 방법을 알고 싶습니다 둘은 다음과 같습니다 1) 나는 '필요'모듈 (버즈) 다음 리스너 설정 : 'Vue.js'를 사용하는 경우 var Buzz = require("Buzz");

0열

1답변

module.exports가 함수 인 모듈을 어떻게 문서화합니까?

함수를 내보내는 노드 모듈을 문서화하려고하지만 jsdocs 출력의 함수에 대한 참조를 얻지 못하고 있습니다. 출력은 기본 템플릿을 사용하여, 그냥 다음과 같습니다 모듈 : testModule 제목 아래 아무것도 . 여기 내가 지금까지 시도했습니다 내용은 다음과 같습니다 1 /** * @module testModule */ 'use strict';

0열

1답변

WebStorm : Jsdoc에서 확인할 수없는 console.debug() 함수 또는 메소드

console.debug()를 구현하는 동안 WebStorm "해결되지 않은 함수 또는 메서드"에서이 오류가 발생합니다. 이미 설정 -> 언어 & 프레임 워크 -> 자바 스크립트 -> 라이브러리에 HTML, HTML 5를 추가했습니다. 리드가 도움이 될 것입니다. 미리 감사드립니다.

2열

1답변

AngularJS docs - 어떻게 생성됩니까?

AngularJS documentation은 명확하고 읽기 쉽습니다. 어떻게 생성됩니까? JSDoc을 사용하는 경우 스타일 시트를 사용할 수 있습니까?

4열

2답변

로컬 변수에 대한 올바른 JSDoc 구문은 무엇입니까? 이 같은 함수에 대한

... function example() { var X = 100; ... var Y = 'abc'; ... return Z; } 나는 지역 변수의 일부의 용도를 설명해야합니다. 이 같은 설명 ... function example() { /** * @description - Need

0열

1답변

객체 인 함수 매개 변수의 필드를 문서화하는 데 사용할 구문

나는 인수 (객체) 인 과 그 모든 속성을 문서화하는 적절한 방법이 무엇일까 궁금합니다. 대괄호가 올바르게 이해 되었다면 "선택 사항"입니다. 맞습니까? 개체 속성을 설명하는 데 사용 된 구문이 유효합니까? reqSettings.retryInterval 속성은 숫자이지만 해당 단위를 포함 할 수있는 방법을 찾을 수 없습니다. 이 숫자가 밀리 초 단위임을 나

0열

1답변

jsdoc-grunt 작업에서 jsdoc 옵션을 사용하는 방법

grunt-jsdoc을 사용하여 개인 방법에 대한 설명서를 생성하려면 -p 플래그를 추가하고 싶습니다. 어떻게해야합니까? grunt-jsdoc의 설명서에 따르면 useJsDocCli에 지정된 옵션 중 하나를 사용할 수 있다고 나와 있지만, 불만스런 작업에 어떻게 지정해야하는지는 알 수 없습니다. 나는이 작업은 -p 플래그 (또는 다른 플래그) 실행하려는 j

1열

2답변

Object.defineProperty로 정의 된 설명 속성

Object.defineProperty으로 추가 된 속성에 대한 JSDoc 문서를 추가하고 싶습니다. /** @constructor */ function MyClass() { /** @property {Number} rnd */ Object.defineProperty(