// My function does X and Y. // @params {object} parameters An object containing the parameters // @params {function} callback The callback function function(parameters, callback) { } Mais comment décrire la structure de l'objet paramètres? Par exemple, cela devrait être quelque chose comme: {...
Comment puis-je informer JSDoc de la structure d'un objet renvoyé. J'ai trouvé la @return {{field1: type, field2: type, ...}} descriptionsyntaxe et l' ai essayé: /** * Returns a coordinate from a given mouse or touch event * @param {TouchEvent|MouseEvent|jQuery.Event} e * A valid mouse or touch...
Selon le wiki JSDoc pour @param, vous pouvez indiquer qu'un @param est facultatif en utilisant /** @param {String} [name] */ function getPerson(name) { } et vous pouvez indiquer un paramètre en ligne en utilisant function getPerson(/**String*/ name) { } Et je peux les combiner comme suit, ce qui...
Dans JSDoc, la meilleure documentation que je peux trouver montre l'utilisation de ce qui suit si vous avez un tableau d'un type spécifique (tel qu'un tableau de chaînes) comme: /** * @param {Array.<string>} myStrings All my awesome strings */ function blah(myStrings){ //stuff here... }...
Auparavant, j'ai toujours documenté mes paramètres d'objet comme suit: /** * 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 {...
J'ai une fonction de style ES6 qui est définie à l'aide de la composition de fonction avec 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...