Index
DRAFT
Getting Started
- An introduction to JSDoc 3
- A quick-start to documenting JavaScript with JSDoc.
JSDoc 3 Tag Dictionary
- @augments or @extends
- This object adds onto a parent object.
- @borrows
- This object uses something from another object.
- @constructor or @class
- This function is intended to be called with the "new" keyword.
- @classdesc
- Use the following text to describe the entire class.
- @constant or @const
- Document an object as a constant.
- @copyright
- [todo] Document some copyright information.
- @constructs
- [todo] This function member will be the constructor for the previous class.
- @default
- Document the default value.
- @deprecated
- [todo] This is no longer the preferred way.
- @desc or @description
- [todo] Describe the object.
- @enum
- Document a collection of related properties.
- @event
- [todo] Document an event.
- @example
- [todo] Provide an example.
- @throws or @exception
- [todo] Describe what errors could be thrown.
- @exports
- [todo] Document the name of a JavaScript module.
- @file or @overview or @fileoverview
- [todo] Describe a file.
- @fires
- [todo] Describe the events this object may fire.
- @global
- [todo] Document a global object.
- @ignore
- [todo] Remove this from the final output.
- @inner
- [todo] Document an inner object.
- @instance
- [todo] Document an instance member.
- @kind
- [todo] What kind of object is this?
- @license
- [todo] Document the software license that applies to this code.
- @member or @var
- [todo] Document a member.
- @memberof
- [todo] This object is a member or another object.
- @method or @function
- [todo] Describe a method or function.
- @mixes
- [todo] This object mixes in all the members from another object.
- @mixin
- [todo] Document a mix-in object.
- @module
- [todo] Document a JavaScript module.
- @name
- [todo] Document the name of an object.
- @namespace
- [todo] Document a namespace object.
- @param or @arg or @argument
- [todo] Document the parameter to a function.
- @private
- [todo] This member is meant to be private.
- @property
- Document a property of an object.
- @protected
- [todo] This member is meant to be protected.
- @public
- [todo] This member is meant to be public.
- @readonly
- [todo] This variable is meant to be readonly.
- @requires
- [todo] This JavaScript module requires another JavaScript module.
- @returns or @return
- [todo] Document the return value of a function.
- @see
- [todo] Refer to some other documentation for more information.
- @since
- [todo] When was this feature added?
- @summary
- [todo] A shorter version of the full description.
- @this
- [todo] What does the this keyword refer to here?
- @todo
- [todo] Document tasks to be completed for an object.
- @type
- [todo] Document the type of an object.
- @typedef
- [todo] Document a custom type.
- @version
- [todo] Document what version this implementation is.
JSDoc Examples
- CommonJS Modules
- Documenting code that conforms to the CommonJS server-side modules standard.