Javascript Documentation

¿Hay algo como JavaDocs para Javascript? Cuando presiono ctrl + espacio en netbeans IDE mientrasJavascript Documentation

escribiendo javascript, la documentación javascript sale para el objeto especificado. Pero esta documentación es, supongo, propiedad de Netbeans.

Si escribimos javascript de la manera correcta comentada, Netbeans crea documentos para nuestro javascript personalizado también.

¿Podemos encontrar cualquier documentación javascript, fuera de Netbeans? ¿Para que podamos referirnos a eso?

Gracias por la respuesta.

Fuente

2012-01-12 Acn

Tener un vistazo a las páginas doc en Mozilla Developer Network (MDN) para una referencia estática:

Sin embargo, me temo que no hay ninguna ficha -completo que se puede usar dentro de un IDE.

Fuente

2012-01-12 06:49:07 matsev

Exactamente lo que necesitaba. – Acn

Consejo de búsqueda de Google: agregue "mdn" después de un término de JavaScript, por ejemplo, "substr mdn" y la página de MDN correspondiente casi siempre será el primer resultado de búsqueda. – nnnnnn

No me rendiría en la finalización de pestañas para JsDoc (Javadocish) dentro de un IDE. WebStorm dice que lo admiten: http://stackoverflow.com/questions/11076572/seeking-example-of-how-to-use-jsdoc-with-the-webstorm-ide-v-4 – SimplGy

En el código fuente de Google de sus garabatos de página de inicio, usan comentarios que se parecen mucho a los comentarios de javadoc, por lo que debe haber algún estándar que al menos use Google.

Aquí se muestra un ejemplo:

/** 
* 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 
*/

Fuente

2012-08-08 12:05:21 lopsided98

Estos son [JSDoc] (http://en.wikipedia.org/wiki/JSDoc) etiquetas, en este caso para el compilador [Google Closure] (https://developers.google.com/closure/compiler/docs/js-for-compiler), para que puedan servir realmente para un propósito funcional (creo que el compilador realmente los impone, como las etiquetas '@ typedef' y' @ private' en el ejemplo pegado). – Ricket

probar una aplicación llamada Ortelius. Utiliza algún tipo de sintaxis similar a javadoc para genrate la documentación. ortelius.marten.dk

Fuente

2013-04-23 19:30:54 Arne

Respuesta

Cuestiones relacionadas