I recently discovered that Netbeans really likes javascript comments which are formatted like this:

/**
 * This is a sample comment
 * 
 * @param {Number} myParam info about this parameter
 * @return {String} Returns some sample string.
 */
function sample(info) { .. }

This appears to be Javadoc compatible comments, but is it? Is there a resource somewhere which defines what formatting as acceptible? Also, is this style of commenting common to other IDE's such as Eclipse?

Edit: I have uploaded this screenshot to illustrate how Netbeans interprets @param and @return

enter image description here

Thanks.

Edit
Report