«jsdoc» etiketlenmiş sorular

// My function does X and Y. // @params {object} parameters An object containing the parameters // @params {function} callback The callback function function(parameters, callback) { } Ancak parametre nesnesinin nasıl yapılandırılması gerektiğini nasıl anlarım? Örneğin şöyle bir şey olmalı: { setting1 : 123, // (required, integer) setting2 : 'asdf' …

316 javascript  jsdoc 

JSDoc'a döndürülen bir nesnenin yapısı hakkında nasıl bilgi verebilirim? @return {{field1: type, field2: type, ...}} descriptionSözdizimini buldum ve denedim: /** * 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 

İçin JSDoc wiki göre @param bir @param gösterebilir kullanarak isteğe bağlıdır /** @param {String} [name] */ function getPerson(name) { } ve kullanarak satır içi bir parametre belirtebilirsiniz function getPerson(/**String*/ name) { } Ve bunları aşağıdaki gibi birleştirebilirim, bu iyi çalışıyor. /** @param [name] */ function getPerson(/**String*/name) { } Ama mümkünse …

119 javascript  google-closure-compiler  jsdoc 

JSDoc'ta, belirli bir türde bir diziniz varsa (örneğin bir dizi dizesi) aşağıdakileri kullanmak için bulabildiğim en iyi belgeler: /** * @param {Array.<string>} myStrings All my awesome strings */ function blah(myStrings){ //stuff here... } Aşağıdaki soru işaretlerini bir nesne dizisi belirterek nasıl değiştirirsiniz? /** * @param {???????} myObjects All of my …

105 javascript  documentation  jsdoc 

Bir dize parametresini kabul eden bir işleve sahibim. Bu parametre, tanımlanmış birkaç olası değerden yalnızca birine sahip olabilir. Aynı şeyi belgelemenin en iyi yolu nedir? ShapeType, enum veya TypeDef veya başka bir şey olarak tanımlanmalı mı? Shape.prototype.create = function (shapeType) { // shapeType can be "rect", "circle" or "ellipse"... this.type …

96 google-closure-compiler  google-closure  jsdoc  code-documentation 

Daha önce nesne parametrelerimi her zaman aşağıdaki gibi belgelemiştim: /** * 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 

Aşağıdakine benzer bir şeye sahip olduğunuzu varsayalım: var someFunc = function() { // do something here with arguments } Bu işlevin JSDoc'ta herhangi bir sayıda argüman alabileceğini nasıl doğru bir şekilde belgelersiniz? Bu benim en iyi tahminim ama doğru olduğundan emin değilim. /** * @param {Mixed} [...] Unlimited amount of …

84 javascript  jsdoc 

Ben işlev kompozisyonu ile tanımlanmış bir ES6 tarzı işlevi var 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