jsdoc

// My function does X and Y. // @params {object} parameters An object containing the parameters // @params {function} callback The callback function function(parameters, callback) { } But how do I describe how the parameters object should be structured? For example it should be something like: { setting1 : 123, // (required, integer) setting2 : 'asdf' // (optional, string) } Jonny Buchanan From the @param wiki page : Parameters With Properties If a parameter is expected to have a particular property, you can document that immediately after the @param tag for that parameter, like so: /** *

Let's say you have something like the following: var someFunc = function() { // do something here with arguments } How would you correctly document that this function can take any number of arguments in JSDoc? This is my best guess, but I'm not sure it's correct. /** * @param {Mixed} [...] Unlimited amount of optional parameters */ var someFunc = function() { // do something here with arguments } Related to: php - How to doc a variable number of parameters The JSDoc specs and Google's Closure Compiler do it this way: @param {...number} var_args Where "number" is the type of arguments expected.