Documentar su código con JSDoc

1. El principio JSDoc:principio

JSDoc utiliza el concepto de JavaDoc de Java y de las anotaciones. Consiste en incorporar marcadores en sus comentarios. Gracias a estos marcadores, es posible generar documentación más legible, mientras se refuerzan ciertos controles. Herramientas adicionales pueden comprender mejor su código, para realizar un procesamiento de tipo de compresión con Google’s Closure. Finalmente, algunos editores de software como WebStorm y NetBeans pueden interpretar sus marcadores y ayudarlo mejor con la entrada de datos.

También podemos decir que JSDoc es, de alguna manera, una extensión de JavaScript en términos de tipado para identificar mejor los valores utilizados.

Para utilizar JSDoc, sus comentarios deben tener el siguiente formato:

/** 
Sus comentarios 
*/ 

Preste atención y no olvide la doble estrella al inicio del comentario.

Un marcador comienza con @, por ejemplo, @param designará un parámetro de función.

2. Los marcadores JSDoc:marcadores

a. Declaraciones

El caso más simple es el uso del marcador type para designar la naturaleza de una variable o la naturaleza del valor devuelto por una función:

/** @type {Number} */ 
var a = 10; 
 
/** @type {String} */ 
var miCadena = "hello world"; 
 
/** @type {Boolean} */ 
var estado = true; 
 
/** @type {Boolean} */ 
function flag() { 
    return "ok"; ...
Si desea saber más, le proponemos el siguiente libro:
couv_EIT3JAV.png
60-signet.svg
Versión impresa
20-ecran_lettre.svg
Versión online
41-logo_abonnement.svg
En ilimitado con la suscripción ENI
130-boutique.svg
En la tienda oficial de ENI
Anterior
JSHint
Siguiente
Paso de un entorno de desarrollo a un entorno de producción