cDoc

cDoc is a super simple documentation tool. cDoc extracts comments from source code and creates an identical directory tree in the target directory that contains the extracted comments.

Installation

npm install -g @hypercubed/cdoc

Comment formatting rules

Currently cDoc extracts multi-line comments. It does not extract single-line comments. By default, cDoc will extract comments for js and js-ish files (js, mjs, ts, etc). Other languages are supported by including additional file extensions (see CLI below). Language-specific comment syntax can be found here.

CLI

  Usage:
    cdoc [source] [target] - extract comments from source files

  Options:
    --ext [ext]   - specify the source file extensions (comma separated, default: ts,js,tsx,jsx,mjs)
    --out [ext]   - specify the output file extension (default: md)
    --dry         - dry run
    --silent      - silent mode

License

This project is licensed under the MIT License - see the LICENSE file for details