+ 3

does @var inside javascript comment contains any meaning?

in some strong and advanced files on GitHub, you find something like this: /** * The router is in charge of handling `yo` different screens. * @constructor * @param {Environment} env A yeoman environment instance * @param {Insight} insight An insight instance * @param {Configstore} [conf] An optional config store instance */ Does this comment contains any effect on the code or it is a normal comment??

6th Feb 2020, 12:33 PM
Ahmad Ali
Ahmad Ali - avatar
3 Antworten
+ 3
Ahmad Ali , This type of comments are used to generate documentations from source code using JSDocs , a documentation tool. This post provides nice introduction : https://dev.to/paulasantamaria/document-your-javascript-code-with-jsdoc-2fbf This one also https://www.valentinog.com/blog/jsdoc/
6th Feb 2020, 1:18 PM
🇮🇳Omkar🕉
🇮🇳Omkar🕉 - avatar
+ 2
「HAPPY TO HELP」 can you explain more please or suggest me something to read?
6th Feb 2020, 12:36 PM
Ahmad Ali
Ahmad Ali - avatar
+ 2
No. These comments have no effect on code. You can also create your comments by using these. /* sololearn is best. I am the best */
6th Feb 2020, 12:50 PM
🇮🇳Vivek🇮🇳
🇮🇳Vivek🇮🇳 - avatar