Minor fixes, comments

boilerplates/controller.js

@@ -2,14 +2,17 @@ const typedefs = require("../typedefs");
 const logger = require("../utils/logger")(module);
 
 /**
- * @param {typedefs.Req} req
- * @param {typedefs.Res} res
+ * Business logic to go in these controller functions.
+ * Everything should be contained inside try-catch blocks
+ * 
+ * @param {typedefs.Req} req Express request object
+ * @param {typedefs.Res} res Express response object
  */
 const __controller_func = async (req, res) => {
 	try {
 
 	} catch (error) {
-		logger.error("Error", { error });
+		logger.error("__controller_func", { error });
 		return res.status(500).send({ message: "Server Error. Try again." });
 	}
 }

boilerplates/route.js

@@ -1,13 +1,18 @@
 const router = require("express").Router();
 
 const { validate } = require("../validators");
+const { __controller_func } = require("./controller");
 
 router.get(
-
+	// URL,
+	// middleware,
+	// validators,
+	// validate,
+	// __controller_func
 );
 
 router.post(
-
+	//similar
 );
 
 module.exports = router;

boilerplates/validator.js

@@ -3,6 +3,12 @@ const { body, header, param, query } = require("express-validator");
 const typedefs = require("../typedefs");
 
 /**
+ * Validator middleware function
+ * 
+ * Use the necessary part of the request, such as params for URL parameters, or query for query parameters.
+ * 
+ * Refer https://github.com/validatorjs/validator.js for a full list of the validators and sanitizers available.
+ * 
  * @param {typedefs.Req} req 
  * @param {typedefs.Res} res 
  * @param {typedefs.Next} next