Programowanie jsdoc

6

Jak opisać argumenty „obiektowe” w jsdoc?

// 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, // (required, integer) setting2 : 'asdf' …

316 javascript jsdoc

3

JSDoc: Zwróć strukturę obiektu

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 or a jQuery event wrapping such an * …

144 javascript documentation-generation jsdoc code-documentation jsdoc3

4

Jak wskazać, że parametr jest opcjonalny, używając wbudowanego JSDoc?

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. /** @param [name] */ function getPerson(/**String*/name) …

119 javascript google-closure-compiler jsdoc

1

Jak określić tablicę obiektów jako parametr lub wartość zwracaną w JSDoc?

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ć poniższe znaki zapytania na tablicę obiektów? /** * @param {???????} myObjects All …

105 javascript documentation jsdoc

5

Jak udokumentować typ łańcucha w jsdoc z ograniczonymi możliwymi wartościami

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 (shapeType) { // shapeType can be "rect", "circle" or "ellipse"... this.type …

101 google-closure-compiler google-closure jsdoc code-documentation

3

Dokument zniszczony parametr funkcji w JSDoc

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 = {}) { const { foo, bar } = …

89 arguments ecmascript-6 jsdoc destructuring

6

Jak określić rozdzielczość i typ odrzucenia promesy w JSDoc?

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?

84 javascript node.js documentation jsdoc promise

4

Poprawny sposób dokumentowania otwartych funkcji argumentowych w JSDoc

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 {Mixed} [...] Unlimited amount of optional …

84 javascript jsdoc

4

Jak zwrócić void w 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 ... */

81 javascript ide jsdoc

2

Jak wygenerować JSDoc dla funkcji `pipe`d ES6

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 liftedGetToken = async ({ ...rest }) => ({ token: …

10 javascript ecmascript-6 functional-programming intellisense jsdoc

Pytania otagowane jako jsdoc