JSDoc

De Wikipedia, la enciclopedia libre
Saltar a: navegación, búsqueda

JSDoc es una sintaxis para agregar documentación de la API al código fuente de JavaScript.

La sintaxis JSDoc es similar a la sintaxis de Javadoc, usado para documentar el código de Java, pero se ha especializado para trabajar con la sintaxis de JavaScript, es más dinámico y, por tanto único, ya que no es totalmente compatible con Javadoc. Sin embargo, como Javadoc, JSDoc permite al programador crear Doclets y Taglets que luego se pueden traducir en formatos como HTML o RTF.

Etiquetas JSDoc[editar]

Etiqueta Descripción
@author Nombre del autor.
@constructor Indica el constructor.
@deprecated indica que ese método es deprecated.
@exception sinónimo de @throws.
@param parámetros de documentos y métodos.
@private indica que el método es privado.
@return indica que devuelve el método.
@see Indica la asociación con otro objeto.
@throws Indica la excepción que puede lanzar un metodo.
@version indica el número de version o libreria.

Enlaces externos[editar]

Pagina oficial (ingles)