Documentazione Javascript

Esiste qualcosa come JavaDocs per Javascript? Quando premo ctrl + spazio in netbeans IDE mentreDocumentazione Javascript

scrivendo javascript, la documentazione javascript esce per l'oggetto specificato. Ma questa documentazione è la proprietà di Netbeans.

Se scriviamo javascript nel modo corretto commentato, anche Netbeans crea documenti per il nostro javascript personalizzato.

È possibile trovare una documentazione di questo tipo, al di fuori di Netbeans? In modo che possiamo riferirci ad esso?

Grazie per la risposta.

fonte

2012-01-12 Acn

Dai un'occhiata alla pagine doc di Mozilla Developer Network (MDN) per un riferimento statico:

Tuttavia, temo che non v'è alcuna scheda -completion che può essere utilizzato all'interno di un IDE.

fonte

2012-01-12 06:49:07 matsev

Esattamente quello di cui avevo bisogno. – Acn

Suggerimento di ricerca Google: aggiungi "mdn" dopo un termine javascript, ad es. "Substr mdn" e la pagina MDN corrispondente sarà quasi sempre il primo risultato di ricerca. – nnnnnn

Non vorrei rinunciare al completamento delle schede per JsDoc (Javadocish) all'interno di un IDE. WebStorm dice che lo supportano: http://stackoverflow.com/questions/11076572/seeking-example-of-how-to-use-jsdoc-with-the-webstorm-ide-v-4 – SimplGy

Nel codice sorgente di Google dei doodles della loro home page, usano commenti che sembrano molto simili ai commenti di javadoc, quindi ci deve essere uno standard che almeno Google usi.

Ecco un esempio:

/** 
* Configuration for a simulator speed setting. 
* - stepTime: ms between simulation steps that do something. 
* - emptyStepTime: ms between no-op steps. 
* - tapeTime: ms for a tape operation. 
* - branchTime: ms for a branch operation. 
* @typedef {{stepTime: number, tapeTime: number, emptyStepTime: number, 
*   branchTime: number}} 
* @private 
*/

fonte

2012-08-08 12:05:21 lopsided98

Questi sono [JSDoc] (http://en.wikipedia.org/wiki/JSDoc) tag, in questo caso per il [compilatore Google Closure] (https://developers.google.com/closure/compiler/docs/js-for-compiler), in modo che possano effettivamente servire a uno scopo funzionale (penso che il compilatore li imponga effettivamente, come i tag '@ typedef' e' @ private' nell'esempio incollato). – Ricket

Prova un'applicazione chiamata Ortelius. Usa una sorta di sintassi javadoc come genrare la documentazione. ortelius.marten.dk

fonte

2013-04-23 19:30:54 Arne

Documentazione Javascript

risposta

Problemi correlati