Este es el comando jsdoc que se puede ejecutar en el proveedor de alojamiento gratuito de OnWorks utilizando una de nuestras múltiples estaciones de trabajo en línea gratuitas, como Ubuntu Online, Fedora Online, emulador en línea de Windows o emulador en línea de MAC OS.
PROGRAMA:
NOMBRE
jsdoc - generador automático para documentación HTML de fuentes Javascript
SINOPSIS
jsdoc {-d = | --directory =} [opciones] ...
jsdoc [{-h | --ayuda}]
DESCRIPCIÓN
Esta página de manual documenta brevemente la jsdoc mando.
jsdoc es una aplicación, escrita en JavaScript, para generar automáticamente
documentación HTML de varias páginas con formato de plantilla (o XML, JSON o cualquier otra documentación basada en texto)
del código fuente JavaScript comentado.
OPCIONES
El programa sigue la sintaxis habitual de la línea de comandos GNU, con opciones largas que comienzan con dos
guiones (`- '). Un resumen de las opciones se incluye a continuación. Para obtener una descripción completa, consulte el
info(1) archivos.
-a, --todas las funciones
Incluya todas las funciones, incluso las indocumentadas.
-c, --conf
Cargue un archivo de configuración.
-d =, --directory =
Salida a este directorio (parámetro obligatorio).
-D ="myVar: Mi valor", --define ="myVar: Mi valor"
Múltiple. Defina una variable, disponible en JsDoc como JSDOC.opt.D.myVar.
-e =, --encoding =
Utilice esta codificación para leer y escribir archivos.
-E ="REGEX", --exclude ="REGEX"
Múltiple. Excluya archivos según la expresión regular proporcionada.
-h, --ayuda
Muestre este mensaje y salga.
-m, --múltiplos
No advierta sobre los símbolos que se documentan más de una vez.
-n, --sin código
Ignore todo el código, solo documente los comentarios con etiquetas @name.
-o =, --out =
Imprime mensajes de registro en un archivo (predeterminado en stdout).
-p, --privado
Incluya símbolos etiquetados como privados, subrayados e internos.
-q, --tranquilo
No envíe ningún mensaje, ni siquiera advertencias.
-r =, --recurse =
Desciende a los directorios src.
-s, --reprimir
Suprime la salida del código fuente.
-S, --módulos seguros
Utilice el modo Módulos seguros para analizar el código fuente.
-t =, --template =
Utilice esta plantilla para formatear la salida.
-T, --prueba
Ejecute todas las pruebas unitarias y salga.
-u, --único
Obligar a que los nombres de archivo sean únicos, pero no basados en nombres de símbolos.
-v, --verboso
Proporcione comentarios detallados sobre lo que está sucediendo.
-x =[, EXT] ..., --ext =[, EXT] ...
Escanee los archivos de origen con la extensión dada (el valor predeterminado es js).
Use jsdoc en línea usando los servicios de onworks.net
