// My function does X and Y. // @params {object} parameters An object containing the parameters // @params {function} callback The callback function function(parameters, callback) { } Ale jak opisać strukturę obiektów parametrów? Na przykład powinno to być coś takiego: { setting1 : 123, //...
Jak mogę poinformować JSDoc o strukturze zwracanego obiektu. Znalazłem @return {{field1: type, field2: type, ...}} descriptionskładnię i wypróbowałem ją: /** * Returns a coordinate from a given mouse or touch event * @param {TouchEvent|MouseEvent|jQuery.Event} e * A valid mouse or touch event...
Zgodnie z wiki JSDoc dla @param możesz wskazać, że @param jest opcjonalne, używając /** @param {String} [name] */ function getPerson(name) { } i możesz wskazać parametr w tekście, używając function getPerson(/**String*/ name) { } I mogę je łączyć w następujący sposób, co działa dobrze. /**...
W JSDoc, najlepsza dokumentacja, jaką mogę znaleźć, pokazuje użycie następującego, jeśli masz tablicę określonego typu (na przykład tablicę ciągów), taką jak: /** * @param {Array.<string>} myStrings All my awesome strings */ function blah(myStrings){ //stuff here... } Jak zamienić...
Mam funkcję, która akceptuje jeden parametr ciągu. Ten parametr może mieć tylko jedną z kilku zdefiniowanych możliwych wartości. Jaki jest najlepszy sposób na udokumentowanie tego samego? Czy shapeType należy zdefiniować jako enum, TypeDef czy coś innego? Shape.prototype.create = function...
Wcześniej zawsze dokumentowałem parametry mojego obiektu w następujący sposób: /** * Description of the function * * @param {Object} config - The configuration * @param {String} config.foo * @param {Boolean} [config.bar] - Optional value * @return {String} */ function doSomething (config...
Powiedzmy, że masz coś takiego: var someFunc = function() { // do something here with arguments } Jak poprawnie udokumentowałbyś, że ta funkcja może przyjmować dowolną liczbę argumentów w JSDoc? To moje najlepsze przypuszczenie, ale nie jestem pewien, czy jest poprawne. /** * @param...
Mam kod, który zwraca obiekt obietnicy, np. Używając biblioteki Q dla NodeJS. var Q = require('q'); /** * @returns ??? */ function task(err) { return err? Q.reject(new Error('Some error')) : Q.resolve('Some result'); } Jak udokumentować taką zwracaną wartość za pomocą JSDoc?...
Czy istnieje określony sposób zadeklarowania metody lub funkcji zwracającej void w JsDoc? Obecnie uważam, że voidjest to domyślna wartość zwracana, a inne wartości zwracane muszą być szczegółowo określone: /** * @return {Integer} The identifier for ... */
Mam funkcję w stylu ES6, która jest definiowana za pomocą kompozycji funkcji z 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...