@todo

Syntax

@todo text

Overview

Attention@todo items appear in generated docs — avoid committing unfinished work to public APIs without a plan to resolve them.

@todo records a task that still needs to be done. Multiple @todo tags are allowed in a single comment block. Some documentation templates render todos in a dedicated section.

Example

/**
 * @todo Add input validation.
 * @todo Write unit tests for edge cases.
 */
function processPayment(amount, currency) {}

See also

• @description

Official reference: jsdoc.app/tags-todo