JSDoc Cheatsheet

Objects & Interfaces

Document object structures, interfaces, and inheritance

@interface
Documents an interface that classes can implement

Syntax:

@interface InterfaceName

Example:

/**
 * @interface Drawable
 * @description Interface for drawable objects
 */
@implements
Indicates that a class implements an interface

Syntax:

@implements {InterfaceName}

Example:

/**
 * @class Circle
 * @implements {Drawable}
 */
@extends
Documents class inheritance

Syntax:

@extends ParentClass

Example:

/**
 * @class ColoredCircle
 * @extends Circle
 */
@mixin
Documents a mixin that can be mixed into classes

Syntax:

@mixin MixinName

Example:

/**
 * @mixin EventEmitter
 * @description Adds event handling capabilities
 */