JSDoc - javascript

File description

/**
    * @file This is the overarching description of the file
    * <br /> It can extend to multiple lines
    * <br /> Yes many lines
    * @author slgotting
*/
        

Function description

/**
    * This is a function.
    *
    * @param {string} n - A string param
    * @param {string} [o] - An optional string param
    * @param {string} [d=DefaultValue] - An optional string param
    * @return {string} A good string
    *
    * @example
    *
    *     foo('hello')
*/
function foo(n, o, d) {
    return n
}
        

Variable description

/**
    * Tailwind described size using both height and width
    * @type {type}
    * @example
    * "h-4 w-4"
*/
export let size = "h-4 w-4";