May 18, 2022 0 Comments

Table of Contents

  1. Getting Started
  2. JSDoc Examples
  3. Contribute
  4. JSDoc 3 Tag Dictionary

Getting Started

Basic info on JSDoc 3.
An introduction to JSDoc 3
A quick-start to documenting JavaScript with JSDoc.
Using namepaths with JSDoc 3.
A guide to using namepaths with JSDoc 3.
Tutorials mechanism
Additional longtext tutorials for your code.
Adding Content to Index.html
Using Readme files to add content to the default index.html
Command-line options to JSDoc 3
About the command-line options JSDoc supports.
Configuring JSDoc 3 with conf.json
How to configure JSDoc’s output with a configuration file.
Linking using inline tags
All about inline tags @link, @linkplain, @linkcode, @tutorial.
All about plugins
Installing plugins and writing your own.
Configuring the markdown plugin
This allows markdown in code comments and offers 2 flavors.
Testing JSDoc 3
About running the self tests included with JSDoc 3.
The license covering JSDoc 3 code.

JSDoc Examples

CommonJS Modules
Documenting code that conforms to the CommonJS server-side modules standard.


JSDoc 3 at github
Contribute to the JSDoc 3 project.
JSDoc 3 Documentation
Contribute to the JSDoc 3 Documentation project.

JSDoc 3 Tag Dictionary

Inline tags
All about inline tags {@link …}, {@linkplain …}, {@linkcode …}, {@tutorial …}.
This member must be implemented (or overridden) by the inheritor.
Specify the access level of this member – private, public, or protected.
Treat a member as if it had a different name.
This object adds onto a parent object.
Identify the author of an item.
This object uses something from another object.
Document a callback function.
Use the following text to describe the entire class.
Document an object as a constant.
This function is intended to be called with the “new” keyword.
This function member will be the constructor for the previous class.
Document some copyright information.
Document the default value.
Document that this is no longer the preferred way.
Describe a symbol.
Document a collection of related properties.
Document an event.
Provide an example of how to use a documented item.
Identify the member that is exported by a JavaScript module.
Document an external class/namespace/module.
Describe a file.
Describe the events this method may fire.
Document a global object.
[todo] Remove this from the final output.
Document an inner object.
Document an instance member.
What kind of symbol is this?
Document properties on an object literal as if they belonged to a symbol with a given name.
[todo] Document the software license that applies to this code.
Inline tag – create a link.
Document a member.
This symbol belongs to a parent symbol.
Describe a method or function.
This object mixes in all the members from another object.
Document a mixin object.
Document a JavaScript module.
Document the name of an object.
Document a namespace object.
Document the parameter to a function.
This symbol is meant to be private.
Document a property of an object.
This member is meant to be protected.
This symbol is meant to be public.
This symbol is meant to be read-only.
This file requires a JavaScript module.
Document the return value of a function.
Refer to some other documentation for more information.
When was this feature added?
Document a static member.
A shorter version of the full description.
What does the ‘this’ keyword refer to here?
Describe what errors could be thrown.
Document tasks to be completed.
Insert a link to an included tutorial file.
Document the type of an object.
Document a custom type.
Distinguish different objects with the same name.
Documents the version number of an item.

Fork me on GitHub