D
Daz
Hi everyone.
Sorry for the meaningless subject. I honestly didn't know what to put.
I have noticed a lot of scripts these days seem to have something like
this:
/**
* Function description
* @param {object} p1: first parameter
* @param {object} p2: 2nd parameter
*/
I know the above might not be entirely correct, but I hope you get the
idea.
My IDE seems to support this quite well, and has functionality to help
tell me what functions do when I hover over them with my mouse. My
question is, what is this form of commenting known as? If I know what
its called, I can look into it, and hopefully make good use of it.
Many thanks.
Daz.
Sorry for the meaningless subject. I honestly didn't know what to put.
I have noticed a lot of scripts these days seem to have something like
this:
/**
* Function description
* @param {object} p1: first parameter
* @param {object} p2: 2nd parameter
*/
I know the above might not be entirely correct, but I hope you get the
idea.
My IDE seems to support this quite well, and has functionality to help
tell me what functions do when I hover over them with my mouse. My
question is, what is this form of commenting known as? If I know what
its called, I can look into it, and hopefully make good use of it.
Many thanks.
Daz.