jsdoc3

5calore

2risposta

Javascript + JsDoc: come documentare nuovi tipi di dati ES6 come la mappa?

Sto cercando di utilizzare JSDoc nel mio progetto ES6, sto tornando una mappa: /** * Some documentation.. * * @returns {undefined} <- This should be replaced */ function returningMap() { con

17calore

1risposta

jsdoc modo corretto per documentare socket.on ('evento', function() {}) e percorsi gestore

Come documentare API utilizzando jsdoc che ha seguente modulo (file singolo) // api.js exports.addSocketEvents = function(socket) { /** * This will do that and ... * @param {Object} d

9calore

1risposta

Come creare tipi jsdoc da schemi json

Ho tonnellate di schema json per il progetto node.js. Posso utilizzarli in alcun modo per: accedervi come tipi jsdoc da file di codice ".js" per aumentare WebStorm intellisense precisione o per creare

7calore

1risposta

Il messaggio di errore "Non ci sono file di input da elaborare" da jsdoc

Jsdoc è installato localmente (npm install jsdoc). Ottengo il seguente errore durante il tentativo di eseguire .\node_modules.bin\jsdoc --debug ./lib/JavaScriptSource.js uscita: DEBUG: JSDoc 3.3.0-dev

12calore

1risposta

metodi nidificati in barra laterale di JSDoc

Grazie alla risposta trovato qui: https://stackoverflow.com/a/19336366/592495 documentazione mio JavaScript è ben organizzato e ben formattato-. Ogni spazio dei nomi è un "genitore" dei metodi contenu

9calore

1risposta

AMD + Backbone + JSDoc3 il modo migliore per documentare

Sto cercando il modo migliore per documentare il mio codice, ma non trovo nulla. Ho visto altri argomenti, tra cui this, ma non tutti risolvono il mio problema. ho qualcosa di simile a questo: define(

13calore

1risposta

Come documentare una funzione restituita da una funzione utilizzando JSDoc

Sto utilizzando JSDoc per la documentazione dei parametri. È chiaro come documentare i tipi di parametri per many_prompts, ma qual è il modo corretto per documentare la funzione restituita? /** * @pa