I noticed the @ symbols mentioned in many javascript files and couldn\'t figure out the significance of this character there. for example:
/**
* Call
that is a javadoc style comment. look at the javadoc documentation
It's only for documentation purpose.
@param is here to indicate which param your function will take for exemple. There is few more, like @author, etc.
@param tag Specifies information for a parameter in a function or method.
link : https://docs.microsoft.com/en-us/visualstudio/ide/create-jsdoc-comments-for-javascript-intellisense?view=vs-2015
That comment is JSDoc. The @param callbackfn
means "what follows is the description of the argument callbackfn
".
Your IDE might be able to parse that format or you can use jsdoc to generate documentation from that.