What is the correct JSDoc syntax for a local variable?
I usually use something like the code below in my projects.
function example() { /** * Need to explain the purpose of X here. * @type {number} */ var X = 100; ... /** * Need to explain the purpose of Y here. * @type {string} */ var Y = 'abc'; ... return Z;}
It seems that JS Docs ignores comments within the "block" (E.g. class, function, etc.). I tried...
@description@inner@instance@member@memberof@name@summary...and others. I was unable to get any of them to generate documentation. Throughout the JS Doc examples they use normal JS comments for this sort of thing.
I have concluded that there is no official JS Doc syntax for this.