jsdoc पर टैग किए गए जवाब

// My function does X and Y. // @params {object} parameters An object containing the parameters // @params {function} callback The callback function function(parameters, callback) { } लेकिन मैं कैसे वर्णन करता हूं कि पैरामीटर ऑब्जेक्ट को कैसे संरचित किया जाना चाहिए? उदाहरण के लिए यह कुछ इस तरह होना …

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 * …

144 javascript  documentation-generation  jsdoc  code-documentation  jsdoc3 

@ अपरम के लिए जेएसडीओसी विकि के अनुसार आप इंगित कर सकते हैं कि @param वैकल्पिक है /** @param {String} [name] */ function getPerson(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... } …

105 javascript  documentation  jsdoc 

मेरे पास एक फ़ंक्शन है जो एक स्ट्रिंग पैरामीटर को स्वीकार करता है। इस पैरामीटर में कुछ परिभाषित संभावित मानों में से केवल एक हो सकता है। उसी दस्तावेज का सबसे अच्छा तरीका क्या है? क्या आकृति को Enum या TypeDef या कुछ और के रूप में परिभाषित किया जाना …

96 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 …

90 arguments  ecmascript-6  jsdoc  destructuring 

मेरे पास कुछ कोड है जो एक वादा वस्तु लौटाता है, जैसे कि NodeJS के लिए Q लाइब्रेरी का उपयोग करना। 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 में किसी भी तर्क को ले सकता है? यह मेरा सबसे अच्छा अनुमान है, लेकिन मुझे यकीन नहीं है …

84 javascript  jsdoc 

क्या JsDoc में शून्य लौटाने के लिए कोई विधि या फ़ंक्शन घोषित करने का कोई निर्दिष्ट तरीका है? वर्तमान में मैं इस विश्वास में हूं कि voidडिफ़ॉल्ट रिटर्न मान है, और अन्य रिटर्न मान विशेष रूप से प्रदान किए जाने चाहिए: /** * @return {Integer} The identifier for ... */

81 javascript  ide  jsdoc 

मेरे पास ईएस 6-शैली का फ़ंक्शन है जिसे फ़ंक्शन रचना का उपयोग करके परिभाषित किया गया है 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 …

10 javascript  ecmascript-6  functional-programming  intellisense  jsdoc