javascript - How to document an "object" parameter of a method - Stack Overflow

admin管理员组

文章数量:1349231

I'm trying to write some documentation for a JavaScript method using YUIDoc. It looks like:

/** 
    Returns an instance of className

    @method getInstance
    @param {string} className the of the class used to create the instance
    @param {Object} options these are options used to create the instance
**/
function getInstance(className, options) { ..... }

Now, the options object can have several parameters, like options.id, options.single, etc.

How do I add this information to the documentation of this @param?

I'm trying to write some documentation for a JavaScript method using YUIDoc. It looks like:

/** 
    Returns an instance of className

    @method getInstance
    @param {string} className the of the class used to create the instance
    @param {Object} options these are options used to create the instance
**/
function getInstance(className, options) { ..... }

Now, the options object can have several parameters, like options.id, options.single, etc.

How do I add this information to the documentation of this @param?

• javascript
• documentation
• yuidoc

Share Improve this question Follow edited Jan 24, 2018 at 13:10 Mogsdad 45.8k2121 gold badges163163 silver badges285285 bronze badges asked Mar 13, 2013 at 21:23 Jeanluca ScaljeriJeanluca Scaljeri 29.2k6666 gold badges235235 silver badges382382 bronze badges 1

• Google Closure Compiler would mark that up as {{id:string,single:whatever}} or {Object.<string,string>} if it's a general dictionary, but I don't know if this is mon syntax or an extension to it. See the bottom of this page: developers.google./closure/piler/docs/js-for-piler – Dave Commented Mar 13, 2013 at 21:30

Add a ment  | 

2 Answers 2

Sorted by: Reset to default 6

In YUIDOC 0.3.45, which is the current version at the time of writing, in order to describe objects received by methods you should first declare the object (options, in the example below) and then it's properties with a dot notation (for example, options.url).

/**
 * Describe your method
 *
 * @method yourMethodName
 * @param {object} options - These are the options you may pass
 * @param {string} options.url - the url
 * @param {string} options.otherOption - description of other option
 */

From reference: http://yui.github./yuidoc/syntax/index.html

"As shown in the example, you can also nest @param tags. This enables you to document object parameters that have their own particular nested structure."

@param {Object} [options] Data 
  to be mixed into the event 
  facade of the `change` 
  event(s) for these attributes.
  @param {Boolean} [options.silent]
    If `true`, no `change` event 
    will be fired.

本文标签： javascriptHow to document an quotobjectquot parameter of a methodStack Overflow