Commenting "null" value in javascript

Question

What is the right way to comment null value in javascript? For example:

/**
 * Hides an element.
 * @param {String} id - element id (can be {@code null}).
 * @returns {undefined}.
 */
function hide(id) {

    if (id !== null) {
        document.getElementById(id).style.visibility = 'hidden';
    }
}

But the tag {@code null} not working...

Possible duplicate of [How can I document a type in webstorm using just jsdoc?](http://stackoverflow.com/questions/16609786/how-can-i-document-a-type-in-webstorm-using-just-jsdoc) — Paul Sweatte, Mar 13 '16 at 05:43

score 0 · Answer 1 · answered Feb 19 '22 at 12:58

Just came across the same issue myself and found that using backticks (``) did the trick for me. Using the JSDoc comment used in your example, it should look like:

/**
 * Hides an element.
 * @param {String} id - element id (can be `null`).
 * @returns {undefined}.
 */

score 0 · Answer 2 · answered Aug 29 '22 at 06:58

The proper way to document this function in JSDoc is like the following snippet:

/**
 * Hides an element.
 * @param {String | null} id - element id (can be `null`).
 */
function hide(id) {
    if (id !== null) {
        document.getElementById(id).style.visibility = 'hidden';
    }
}

Commenting "null" value in javascript

2 Answers2