jsdoc express routes code example
Example: jsdoc for express routes
/** Express router providing user related routes
* @module routers/users
* @requires express
*/
/**
* express module
* @const
*/
const express = require('express');
/**
* Express router to mount user related functions on.
* @type {object}
* @const
* @namespace usersRouter
*/
const router = express.Router();
/**
* Route serving login form.
* @name get/login
* @function
* @memberof module:routers/users~usersRouter
* @inner
* @param {string} path - Express path
* @param {callback} middleware - Express middleware.
*/
router.get('/login', function(req, res, next) {
res.render('login', {title: 'Login', message: 'You must login'});
});