jsdoc

6calore

2risposta

Correzione della regola jsdoc non supportata

Utilizzando il file .jsrc, viene visualizzato il seguente errore per i miei file server/front-end. Sta generando un errore nella parte superiore dei miei file. Come posso sopprimere questo? Unsupporte

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

8calore

2risposta

JSDoc eredita la documentazione dei parametri

Diciamo che ho due funzioni, in cui una estende l'altra. /** * @abstract * @param {Object} settings * @param {Number} settings.x * @param {Number} settings.y * */ function Base(settings) {

9calore

1risposta

Come rendere WebStorm risolvere i moduli che sono funzioni?

WebStorm fa un ottimo lavoro di funzioni che sono tornati da moduli CommonJS come metodi (e legge JsDoc ad essi associati), come ad esempio la risoluzione: // utils/valid.js /** * Returns true no ma

13calore

1risposta

Qual è la formattazione corretta/canonica delle lunghe linee JSDoc?

Tutti gli esempi ufficiali JSDoc hanno ingenuamente semplici stringhe di documentazione, come la seguente: /** * @param {string} author - The author of the book. */ Il problema è, nella documentaz

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

8calore

1risposta

JSDoc @param insieme a @deprecated

Ho una funzione JavaScript che ottiene alcuni parametri compresi i tipi di oggetto. Tuttavia, una proprietà di un parametro, che è un oggetto, verrà utilizzata come deprecata. Vorrei indicare questa s

7calore

1risposta

Generazione di Swagger YAML da JSDoc?

Ho una grande API JS completamente documentata con JSDoc e sto costruendo un servizio REST basato su spavalderia per rendere l'API disponibile su una rete. Ho creato manualmente una versione iniziale

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