Search code examples
javascriptjsdoc

jsdoc valid param types

Is there a list somewhere of valid types for param tags for jsdoc? For example,

@param {type} myParam Some parameter description

I know that things like number and String are valid, but what if I want to document that the number is an integer. Is int valid?

I've done some googling, but I can't seem to find a full list.

Solution

  • The JS Documentation tooling I've used just tokenizes the comments into strings anyway, making it possible to put anything you want in the {type} section.

    You could stick with JavaScript types if you wanted like {number} or {string}, or if you want to specify you could do {integer}... but I would probably recommend something like:

    @param {number} myParam must be an integer

    cheers