Crate commentator

commentator

commentator is a crate which provies binary and SDK for extracting comment entries from source code. SDK provides API such as commentator::Tokenizer to push source code line by line into state machine and then pull extracted comments entries with some context, such as line number and offset position.

Binary could be used as CLI tool to extract comments from source code file and print it to stdout.

Modules

spec

Structs

Comment

Tokenizer

Tokenizer for comments. It accepts lines of code as input and generates comment structures as output.