Documentación automática con Deno

Otro gran beneficio de TypeScript es la documentación automática del código mientras lo escribimos.

Esto es especialmente relevante al trabajar en equipo o al desarrollar una librería que otros desarrolladores utilizarán.

Por ejemplo, al crear una librería avanzada de matemáticas para publicar en JSR o NPM, necesitamos proporcionar documentación para que otros entiendan y usen nuestro código. La documentación suele considerarse una tarea tediosa y molesta.

Afortunadamente, Deno puede generar automáticamente la documentación de nuestro código y crear un sitio web publicable con un solo clic.

#Ejemplo

Imaginemos que tenemos un archivo lib.ts que exporta una función multiply. Esta función tiene definido su type, que Deno usa para generar la documentación. Podemos añadir detalles adicionales usando comentarios en formato ts.comment.

/**
 * Multiplies two numbers together.
 */
export function multiply(a: number, b: number) {
    return a * b;
}

#Generando la documentación

Para generar un sitio web de documentación, abrimos el terminal y ejecutamos el comando deno doc con la opción --html y especificamos el nombre de la librería con --name.

deno doc --html --name="Mi librería" lib.ts

Al ejecutar el comando, se creará una carpeta en la raíz del proyecto con un archivo index.html. Podemos servir este archivo localmente o abrirlo en un navegador web copiando su ruta. Esto nos mostrará un sitio web completo con toda nuestra documentación.