Documentation vs Multi-line | Sololearn: Learn to code for FREE!
New course! Every coder should learn Generative AI!
Try a free lesson
0

Documentation vs Multi-line

I still don’t understand what the difference is between a documentation. Please explain!

25th Oct 2019, 9:42 AM
HelenaBla
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.
25th Oct 2019, 9:57 AM
Rishi Anand
Rishi Anand - avatar