jsdoc

11Ciepło

1Odpowiedz

Jak rozszerzyć parametr typedef w JSDOC?

Zakładając, że mamy następujący kod wewnątrz klasy ES6 (dokumentacja): /** * @typedef Test~options * @type {object.<string>} * @property {array} elements - An array containing elements * @property

javascript typedef extend jsdoc type-definition 2016-04-20

---

6Ciepło

1Odpowiedz

Jaka jest właściwa składnia JSDOC do odwoływania się do zaimportowanych klas es6?

Próbuję wykombinować poprawną składnię do określania klas zewnętrznych jako params/zwraca w JSDOC. tak, na przykład, mam: import redux from 'redux'; /** * @param {object} state * @return {{module:

javascript ecmascript-6 webstorm jsdoc commonjs 2015-11-25

---

30Ciepło

6Odpowiedz

Jak wygenerować dokumentację JavaScript API dla GitHub Pages

Istnieje wiele wspaniałych opcji generowania dokumentacji API dla innych języków, ale muszę jeszcze znaleźć rozwiązanie dla mojego JavaScript API, które chcę hostować na stronach GitHub. Wygląda na to

javascript documentation jekyll github-pages jsdoc 2016-03-04

---

11Ciepło

2Odpowiedz

Jak korzystać z JSDoc w systemie Windows?

Przebacz mi, jeśli to głupie pytanie, ale jestem całkowicie zaskoczony, w jaki sposób mogę używać JSDoc w systemie Windows. Jestem świadomy JSDoc-Toolkit, ale jest nieco przestarzały, a repozytorium k

javascript windows jsdoc 2015-11-27

---

7Ciepło

2Odpowiedz

Jak dokument rozwiązane wartości JavaScript obiecuje

Biorąc pod uwagę ten kod: function asyncFoo() { return new Promise(function (fulfill, reject) { doAsyncStuff(function(err, data) { if(err) reject(new Error(err)); else fulfill(ne

javascript jsdoc 2016-03-08

---

9Ciepło

2Odpowiedz

Angular2 Dokumentacja Generator

Czy istnieje generator dokumentacji (może być pakiet węzeł), tak jak w innych językach programowania (JSDoc/PHPDoc/javadoc/..) dla maszynopis opartych Angular2 projektach?

typescript angular documentation-generation jsdoc 2016-06-21

---

8Ciepło

1Odpowiedz

JSDoc + Mongoose: jak dokumentować modele Mongoose?

mam Mongooseschematu a modelu: var MyClientSchema = new mongoose.Schema({ fist_name: { type: String }, phone_number: { type: String } }); var MyClient = mongoose.mod

node.js mongoose jsdoc mongoose-schema 2016-08-12

---

8Ciepło

1Odpowiedz

Jak uzyskać dokładny komunikat o błędzie JsDoc w formacie reactjs?

We are using JsDoc to create our document of reactjs pages. All comment we wrote as per the jsDoc rule but still it showing below message for some page: BŁĄD: Nie można analizować D: \ Przykład \ src

reactjs jsdoc 2017-06-08

---

5Ciepło

1Odpowiedz

Jak opisać destrukturyzowaną argumenty obiekt w JSDoc

Jeśli mam funkcji JavaScript bierze obiekt jako parametr, mogę opisać oczekiwane właściwości obiektu z JSDoc jak ten: /** * @param bar * @param bar.baz {number} * @param bar.qux {number} */ funct

javascript ecmascript-6 jsdoc 2017-06-20

---

12Ciepło

2Odpowiedz

VSCode: Jak dokumentować obietnicę rozwiązującą złożony obiekt?

Mam funkcję f, która zwraca Promise. Zwrócony Promise albo albo albo . Próbowałem następującą składnię (jak wspomniano w an issue in JSDoc) w VSCode, ale to nie działa: /** * @promise fPromise * @re

documentation visual-studio-code jsdoc 2017-08-10

---