W3cubDocs

/JSDoc

@todo

Table of Contents

Syntax

@todo text describing thing to do.

Overview

The @todo tag allows you to document tasks to be completed for some part of your code. You can use the @todo tag more than once in a single JSDoc comment.

Examples

Using the @todo tag
/**
 * @todo Write the documentation.
 * @todo Implement this function.
 */
function foo() {
    // write me
}

© 2011–2017 the contributors to the JSDoc 3 documentation project
Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0.
http://usejsdoc.org/tags-todo.html