Skip to content

Instantly share code, notes, and snippets.

@dooderstem
Last active July 11, 2023 11:38
Show Gist options
  • Save dooderstem/9d22dfb3c769d5a570f7aaa933a3cbdc to your computer and use it in GitHub Desktop.
Save dooderstem/9d22dfb3c769d5a570f7aaa933a3cbdc to your computer and use it in GitHub Desktop.
@use JSDoc
// Document your JavaScript by Adding documentation comments to your code!
// This here is an example usage of https://jsdoc.app/
/*
Once your code is commented, you can use the JSDoc 3 tool to generate an HTML website from
your source files.
By default, JSDoc uses the built-in "default" template to turn the documentation into HTML
You can edit this template to suit your own needs or create an entirely new template if that
is what you prefer. Running the documentation generator on the command line: `jsdoc book.js`
The command above will create a directory named out/ in the current working directory.
Within that directory, you will find the generated HTML pages.
*/
/**
* @author doodercodes: https://github.com/doodercodes
* @version 0.0.1
* @description A very friendly application for your desires.
*/
/**
* @function
* @name asciiTable
* @description builds an ascii table debugging and organization for the node
console
* @param Null
* @returns void
*/
/**
* @description Get goals
* @route GET /api/goals
* @access Private
* @param {*} req - request
* @param {*} res - resolve
*/
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment