jsdoc

0열

1답변

IntelliJ에서 @param 콜백 {Function}의 예상 매개 변수를 어떻게 정의합니까?

많은 콜백을 사용하고 특정 형식의 특정 nr 매개 변수를 사용하여 메서드에서 예상되는 함수 콜백 유형을 편집기에서 검색하도록합니다. 지금 당장은 기능에 대해 언급하고 있으며 무엇이든지 될 수 있지만 구체적으로 설명하고자합니다. IntelliJ에서 이에 해당됩니다.

0열

1답변

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

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

0열

1답변

api/doc 페이지에서 폴리머 (wc) 구성 요소의 버전을 어떻게 설정할 수 있습니까?

폴리머를 사용하여 사용자 지정 웹 구성 요소를 만들고 있는데 설명서를 작성하려고하는데 구성 요소 버전을 변경하거나 설정할 수있는 방법을 찾을 수 없습니다. 저는 yeoman 폴리머 시드 요소와 문서 작성을위한 "핵심 구성 요소 페이지"핵심 구성 요소를 사용하고 있습니다. 나는 시도했다 : @version 0.0.1 그러나 성공하지 못했다. :)

3열

2답변

JSDoc에서 "@ readonly-but-modified-internalally"멤버/속성에 주석을 추가하는 방법은 무엇입니까?

JSDoc는 @readonly doclet tag 가지고 @ReadOnly 태그 기호 읽기 전용되도록 의도되는 것을 나타낸다. 예를 들어 그러나 /** * The name of the represented principal * @member {string} * @readonly */ this.name = primaryName; , 정말가 통신

1열

2답변

Object.defineProperty로 정의 된 설명 속성

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

1열

1답변

jsdoc가 @param 선언을 신뢰하지 않습니다.

다음과 같은 코드에서 jsdoc을 실행하면 @param 문서가 무시됩니다. 필자는 이것이 IIFE에서 함수를 반환하기 때문에 이것이라고 생각합니다. 그러나 이것이 JS의 일반적인 패턴을 고려할 때 jsdoc에서 처리 할 수 없다고 생각하는 것이 어렵습니다. 그것은 기능로 문서화 된 항목을 고려하면 /** @namespace */ var util = {

1열

1답변

가변 함수에 대한 클로저 주석

고급 컴파일 모드에서 Google 클로저 컴파일러로 컴파일 할 코드를 작성하고 있습니다. 내 코드의 일부 위치에는 일반적으로 빈 인수 목록을 사용하여 작성하는 가변 함수가 있습니다. 본문 안의 arguments 특수 변수를 검사하여 전달 된 인수에 액세스합니다. 그러나 이것을 클로저 컴파일러에 annotations을 사용하여 어떻게 설명 할 수 있습니까?

0열

2답변

JSDoc에서 콜백 함수의 매개 변수로 객체 배열을 문서화합니다.

callback.rows은 여러 필드가 반복되는 임의의 길이의 배열입니다. 각 필드 (유형, 속성, 설명)를 JSDoc에 문서화하려면 어떻게해야합니까? 적용 할 수 있습니까? method? 또는이 솔루션은 받아 들여질 수있을 수 있습니다 : /** * Get list of all documents * @param {Function} callback

0열

1답변

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

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

1열

2답변

jsdoc에서 @fires로 이벤트 이름의 점을 처리하는 방법

이벤트 이름이 namespace.event입니다. @fires 태그를 사용하려고 할 때 JsDoc에서 점들이 문제를 일으키고 있습니다. 내가 할 때 : /** @fires MyClass#namespace.myevent */ 결과는 일반 텍스트 MyClass#namespace:event:myevent입니다. 점들을 벗어날 방법이 있습니까? 나는 작동하