babel-plugin-annotate-docs

annotate-docs is babel-plugin that creates a document from comments.

Installation

This module is distributed via npm which is bundled with node and should be installed as one of your project's devDependencies:

npm install --save-dev babel-plugin-annotate-docs

You write a comment as follows.

// NOTE: @konojunya this is PI.
const PI = 3.14;

The form is as follows.

// <prefix>: <who> <what>

// <prefix>: <what>

Then docs/TODO.md is created. There is a list of supported prefix comments in the code.

MIT