jsdoc

5Ciepło

1Odpowiedz

Ostrzeżenie dotyczące implementacji interfejsu Webstorm przy użyciu JSDoc

Jestem bardzo nowy w JSDoc, a ja wypróbowuję Webstorm, więc jestem również bardzo nowy w serwisie Webstorm. mam z jednej strony interfejs zadeklarowane w ten sposób: /** @interface */ function IInter

javascript webstorm jsdoc 2014-11-13

---

7Ciepło

1Odpowiedz

Dokumentowanie fabryk przy użyciu JSDoc

Aby uniknąć używania new w moim kodzie JavaScript, piszę fabryki, aby tworzyć obiekty. Próbowałem wielu kombinacji i jeden, który daje mi najbardziej zadowalający wynik jest następujący: /** * Docume

javascript factory jsdoc 2015-09-13

---

63Ciepło

2Odpowiedz

JSDoc: Zwróć obiekt struktury

Jak mogę powiedzieć JSDoc o strukturze zwróconego obiektu. Znalazłem składnię @return {{field1: type, field2: type, ...}} description i próbowała go: /** * Returns a coordinate from a given mouse or

javascript documentation-generation jsdoc code-documentation jsdoc3 2015-02-27

---

7Ciepło

1Odpowiedz

Jak wyświetlić metody JavaScript w "grupie" w JSDOC?

Czy istnieje możliwość grupowania funkcji w klasie (moduł AMD/RequireJS)? Moje zajęcia mają czasem ponad 20+ funkcji, które w rzeczywistości należą do konkretnej "implementacji interfejsu", a czasem w

javascript jsdoc 2014-11-21

---

8Ciepło

1Odpowiedz

JSDoc @param wraz z @deprecated

Mam funkcję JavaScript pobieranie niektórych parametrów, w tym typów obiektów. Jednak jedna właściwość parametru, który jest obiektem, zostanie użyta jako przestarzała. Chciałbym wskazać tę sytuację w

javascript deprecated jsdoc param 2015-04-21

---

6Ciepło

1Odpowiedz

Jak używać jsdoc z haustem?

Jak utworzyć polecenie gulp do tworzenia dokumentacji za pomocą jsdoc? Nie chcę używać pakietu gulp-jsdoc, ponieważ nie jest on utrzymywany. A pakiet, którego używałem do wywoływania go z linii polece

node.js gulp jsdoc 2015-11-12

---

9Ciepło

2Odpowiedz

JSDocs: Dokumentowanie tras ekspresowych Node.js

Próbuję dokumentować połączenia router.get z JSDocs. Nie mogę uzyskać dokumentacji, która będzie poprawnie wyświetlana na stronie, jeśli spróbuję dołączyć ją do samego routera. /** * Health check *

node.js jsdoc jsdoc3 2015-08-04

---

7Ciepło

1Odpowiedz

Generowanie Swagger YAML z JSDoc?

Mam duże JS API w pełni udokumentowane za pomocą JSDoc, a ja buduję usługę REST opartą na swagge, aby API było dostępne w sieci. Ręcznie stworzyłem wstępną wersję specyfikacji Swamera YAML, ale proble

javascript yaml swagger jsdoc 2015-09-24

---

7Ciepło

1Odpowiedz

Dokumentowanie prywatną konstruktora z JSDoc

Mam klasę gdzie poszczególne metody mogą być wywołana statycznie ale powróci nową instancję klasy w celu łańcucha, na przykład: var builder = ns .setState('a', 'A') .setState('b', 'B'); Gd

javascript constructor private jsdoc 2014-12-11

---

17Ciepło

1Odpowiedz

JSDoc właściwy sposób udokumentować socket.on ('zdarzenie', function() {}) i trasy obsługi

Jak udokumentować za pomocą API JSDoc który następującą postać (pojedynczy plik) // api.js exports.addSocketEvents = function(socket) { /** * This will do that and ... * @param {Objec

javascript node.js comments jsdoc jsdoc3 2015-10-10

---