«jsdoc» 태그된 질문

// My function does X and Y. // @params {object} parameters An object containing the parameters // @params {function} callback The callback function function(parameters, callback) { } 그러나 매개 변수 객체의 구조를 어떻게 설명합니까? 예를 들어 다음과 같아야합니다. { setting1 : 123, // (required, integer) setting2 : 'asdf' // (optional, …

316 javascript  jsdoc 

JSDoc에 반환되는 객체의 구조에 대해 어떻게 알 수 있습니까? @return {{field1: type, field2: type, ...}} description구문 을 찾아서 시도했습니다. /** * Returns a coordinate from a given mouse or touch event * @param {TouchEvent|MouseEvent|jQuery.Event} e * A valid mouse or touch event or a jQuery event wrapping such an * …

144 javascript  documentation-generation  jsdoc  code-documentation  jsdoc3 

@param 에 대한 JSDoc 위키에 따르면 @param이 선택 사항임을 나타낼 수 있습니다. /** @param {String} [name] */ function getPerson(name) { } 다음을 사용하여 매개 변수를 인라인으로 나타낼 수 있습니다. function getPerson(/**String*/ name) { } 그리고 다음과 같이 결합 할 수 있습니다. /** @param [name] */ function getPerson(/**String*/name) { } 그러나 …

119 javascript  google-closure-compiler  jsdoc 

JSDoc에서 찾을 수있는 최고의 문서는 특정 유형의 배열 (예 : 문자열 배열)이있는 경우 다음을 사용하는 방법을 보여줍니다. /** * @param {Array.<string>} myStrings All my awesome strings */ function blah(myStrings){ //stuff here... } 아래 물음표를 어떻게 대체하여 객체 배열을 지정합니까? /** * @param {???????} myObjects All of my equally awesome objects …

105 javascript  documentation  jsdoc 

하나의 문자열 매개 변수를 받아들이는 함수가 있습니다. 이 매개 변수는 정의 된 몇 가지 가능한 값 중 하나만 가질 수 있습니다. 이를 문서화하는 가장 좋은 방법은 무엇입니까? shapeType을 enum 또는 TypeDef 또는 다른 것으로 정의해야합니까? Shape.prototype.create = function (shapeType) { // shapeType can be "rect", "circle" or "ellipse"... this.type = …

98 google-closure-compiler  google-closure  jsdoc  code-documentation 

이전에는 항상 다음과 같이 개체 매개 변수를 문서화했습니다. /** * Description of the function * * @param {Object} config - The configuration * @param {String} config.foo * @param {Boolean} [config.bar] - Optional value * @return {String} */ function doSomething (config = {}) { const { foo, bar } = config; …

89 arguments  ecmascript-6  jsdoc  destructuring 

예를 들어 NodeJS 용 Q 라이브러리를 사용하여 promise 객체를 반환하는 코드가 있습니다. var Q = require('q'); /** * @returns ??? */ function task(err) { return err? Q.reject(new Error('Some error')) : Q.resolve('Some result'); } JSDoc을 사용하여 이러한 반환 값을 문서화하는 방법은 무엇입니까?

84 javascript  node.js  documentation  jsdoc  promise 

다음과 같은 것이 있다고 가정 해 보겠습니다. var someFunc = function() { // do something here with arguments } 이 함수가 JSDoc에서 여러 인수를 취할 수 있다는 것을 어떻게 올바르게 문서화 할 수 있습니까? 이것이 내 최선의 추측이지만 정확한지 모르겠습니다. /** * @param {Mixed} [...] Unlimited amount of optional parameters …

82 javascript  jsdoc 

JsDoc에서 void를 반환하는 메서드 또는 함수를 선언하는 지정된 방법이 있습니까? 현재 저는 void기본 반환 값 이라고 믿고 있으며 다른 반환 값을 구체적으로 제공해야합니다. /** * @return {Integer} The identifier for ... */

81 javascript  ide  jsdoc 

with 함수 구성을 사용하여 정의 된 ES6 스타일 함수가 asyncPipe있습니다. import { getItemAsync } from 'expo-secure-store'; const asyncPipe = (...fns) => x => fns.reduce(async (y, f) => f(await y), x); const getToken = () => getItemAsync('token'); const liftedGetToken = async ({ ...rest }) => ({ token: await getToken(), ...rest, }); …

10 javascript  ecmascript-6  functional-programming  intellisense  jsdoc