Template Examples

Template Examples

The following are the template files that comes pre-installed.

for_each

$[array].forEach(($[element]) => {
    $[]
})

jsdoc

/**
 * $[Description]
 *$|
 * @${EXPORT}|$$|
 * @${ACCESS}|$$|
 * @${ABSTRACT}|$$|
 * @${CONST} ${NAME}|$$|
 * @param$| {${PARAMS_TYPES}}|$ ${PARAMS} $[Description]|$$|
 * @returns {${RETURN_TYPE}} $[Description]|$$|
 * @${RELATION} {${RELATIONNAME}}|$$|
 * @memberof ${PARENT}|$
 */

tomdoc

${COMMENT} $[Description]
${COMMENT} $|
${COMMENT} ${PARAMS}${align(PARAMS)} - $[Description].
${COMMENT} |$$|
${COMMENT} Examples
${COMMENT} $<3>(
${COMMENT}   ${NAME}(${PARAMS_TEMPLATE})
${COMMENT}   # => $[result]
${COMMENT} )$|$
${COMMENT} Returns $[Description].

testing

The following is not meant for any commercial use. It only exists to see what EasyDoc can handle.

# Description: $[Type]
#
# Args:
#     ${NAME} {${args.type?}}: \${$[args]} ${PARAMS}${PARAMS} ${NAME} h
#     ${PARAMS} {${args.type?}}: ${reverse(PARAMS)} ${reverse(NAME)} ${NAME.length} \${NAME} \\${NAME} \\\${NAME}
#     ${PARAMS} {${args.type?}}: ${PARAMS} ${NAME} ${reverse(NAME).length} \${NAME} \\${NAME} \\\${NAME}
#     ${PARAMS} {${args.type?}}: ${align(PARAMS)} \${NAME} \\${NAME} \\\${NAME}
#  
# Examples:$<${NAME.length}>(
#     ${NAME}(${PARAMS_TEMPLATE}) ${PARAMS} ${NAME} \${NAME} \\${NAME} \\\${NAME}
#     # => $[result]
#)$
# Returns:
#     The \${return.type?} $[Return Description]