Plugin Documentation
Good plugins include: purpose description, options table, event list, method reference, and usage examples. JSDoc comments generate API docs automatically.
jQuery
Intermediate
3 min read
Documenting Your Plugin
Example
/**
* @plugin myPlugin
* @version 1.0.0
* @description A jQuery plugin for X.
*
* @param {Object} options - Configuration options
* @param {string} options.color - Highlight color (default: "yellow")
* @param {number} options.duration - Animation ms (default: 400)
*
* @fires myPlugin:shown
* @fires myPlugin:hidden
*
* @example
* $(".target").myPlugin({ color: "pink" });
*/ Pro Tip
JSDoc comments let IDEs provide autocomplete for your plugin options.