<aside> 💡 Make sure to read the Standard Documentation Format!

</aside>

Doc Comments

There isn’t a winning standard out there for JavaScript documentation the way there is for Python, so we use standard comments for this in the following forms:

/**
 * Single-line summary.
 */

Or:

/**
 * Single-line summary.
 *
 * Multi-line description.
 */

Note that these start with /**, and not /*. This is how we will differentiate standard comments from doc comments.

Unlike with Python docstrings (which are placed within the body of a class or method), you will not place a blank line between the end of the docs and any following code.

You should document all the following:

• Classes