Programmazione jsdoc

6

Come descrivere argomenti "oggetto" in jsdoc?

// My function does X and Y. // @params {object} parameters An object containing the parameters // @params {function} callback The callback function function(parameters, callback) { } Ma come posso descrivere come strutturare l'oggetto parametri? Ad esempio dovrebbe essere qualcosa del tipo: { setting1 : 123, // (required, integer) setting2 …

316 javascript jsdoc

3

JSDoc: restituisce la struttura dell'oggetto

Come posso comunicare a JSDoc la struttura di un oggetto che viene restituito. Ho trovato la @return {{field1: type, field2: type, ...}} descriptionsintassi e l'ho provata: /** * Returns a coordinate from a given mouse or touch event * @param {TouchEvent|MouseEvent|jQuery.Event} e * A valid mouse or touch event or …

144 javascript documentation-generation jsdoc code-documentation jsdoc3

4

Come indicare che param è facoltativo utilizzando JSDoc in linea?

Secondo il wiki JSDoc per @param puoi indicare che un @param è facoltativo usando /** @param {String} [name] */ function getPerson(name) { } e puoi indicare un parametro inline usando function getPerson(/**String*/ name) { } E posso combinarli come segue, il che funziona bene. /** @param [name] */ function getPerson(/**String*/name) …

119 javascript google-closure-compiler jsdoc

1

Come specificare un array di oggetti come parametro o valore restituito in JSDoc?

In JSDoc, la migliore documentazione che posso trovare mostra di utilizzare quanto segue se si dispone di un array di un tipo specifico (come un array di stringhe) come: /** * @param {Array.<string>} myStrings All my awesome strings */ function blah(myStrings){ //stuff here... } Come sostituireste i seguenti punti interrogativi …

105 javascript documentation jsdoc

5

Come documentare un tipo di stringa in jsdoc con valori possibili limitati

Sto avendo una funzione che accetta un parametro stringa. Questo parametro può avere solo uno dei pochi valori possibili definiti. Qual è il modo migliore per documentare lo stesso? ShapeType dovrebbe essere definito come enum o TypeDef o qualcos'altro? Shape.prototype.create = function (shapeType) { // shapeType can be "rect", "circle" …

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

3

Documentare il parametro della funzione destrutturata in JSDoc

In precedenza ho sempre documentato i parametri dei miei oggetti come segue: /** * 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, …

90 arguments ecmascript-6 jsdoc destructuring

2

Come generare JSDoc per la funzione `pipe`d ES6

Ho una funzione in stile ES6 che è definita usando la composizione della funzione con 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

Domande taggate «jsdoc»