example-docstring-parser

Example docstring parser

A source code docstring parser for C-like (including C++, JavaScript, Rust) and Python-like syntax.

Syntax

A text is considered a named fragment when it is located between // BEGIN FRAGMENT: <name> and // END FRAGMENT, <> not included. This syntax is case-sensitive.

Don't use special characters in names; snakeCase is preferrable.

Fragments can be included in one another. In that case the lines matching // BEGIN FRAGMENT: <name> and // END FRAGMENT are removed.

Elements between // BEGIN ESCAPE and // END ESCAPE are excluded unconditionally from the tutorial.

Installation

Type npm install example-docstring-parser --save-dev if you want to install it as a development dependency of your package. Type npm install example-docstring-parser -g to install the parser globally.

Example code

import { ExampleParser } from "example-docstring-parser"
let text = `
// BEGIN FRAGMENT: Test
This text is displayed
// BEGIN ESCAPE
OR IS IT?
// END ESCAPE
// END FRAGMENT
`
let parser_inst = new ExampleParser(text)
console.log(parser_inst.mapLines())