包详细信息

jsdoc-region-tag

googleapis38kApache-2.03.0.0

replace region tags with code samples

region, tag, jsdoc, plugin

自述文件

Region Tag JSDoc Plugin

Reads a samples directory, extracting samples between [START]/[STOP] tags, allowing these samples to be placed in JSDoc comments, like so:

/*
  * @example <caption>include:samples/document-snippets/cluster.js</caption>
  * region_tag:bigtable_delete_cluster
  */

Usage

npm i jsdoc-region-tag.

add the plugin to your .jsdoc.js.

 module.exports = {
   plugins: [
     'jsdoc-region-tag'
   ]
 }

Configuration

The environment varaible SAMPLES_DIRECTORY can be set, to set a samples directory other than ./samples.