0
Documentation vs Multi-line
I still donât understand what the difference is between a documentation. Please explain!
1 Answer
0
/* this is multiline comment */
/** This is document */
the document is something like where you provide additional info like author, parameters etc
e.g. Let's say there is a function countCharacters() that takes a string as a parameter and returns the number of characters in it.
/**
*@author Rishi
*
*@param {String} input string
*
*@return {String} number of characters
*
*/
though you can provide the same information using multi-line comment but the use of document instead of a multiline comment for providing this info is the best practice.