commentator 0.2.3

Source code comments extractor binary and SDK
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53

Commentator is a fucking fast source code comments finder CLI and Rust SDK (crate).

**work in progress.**

[![Check](https://github.com/g4s8/commentator/actions/workflows/check.yml/badge.svg)](https://github.com/g4s8/commentator/actions/workflows/check.yml)

[Crates v0.1.0](https://crates.io/crates/commentator)

# Motivation

Existing source code comments extractors (see References) forcomments extracting are quite slow,
not always accurate (don't find all comments) or doesn't provide
SDK. This tool fixes all of this.

# Usage

This library could be used as CLI or from code.

To build CLI from sources (you need Rust and Cargo installed):
```bash
# clone repo
git clone https://github.com/g4s8/commentator.git
cd commentator
# build with cargo
cargo build --release --bin commentator --features feat-bin
# move binary to your $PATH
sudo mv ./target/release/commentator /usr/local/bin
```

Or download from release pages: https://github.com/g4s8/commentator/releases/tag/0.1.0

## CLI usage

`commentator` require file name argument and supports these options:
 - `--format` - output format: either `plain` or `json`
 - `--lang` - language comment specification, one of:
   - `c`,`java`, `go`, `cpp` - for C-like comment syntax
   - `rust` - Rust comments syntax
   - `bash` - for Bash, Python and Ruby
   - `html` - for HTML, XML
 - `--trim` - trim comment symbols and whitespaces, align to the first
   sentence indent.

Example:
```bash
./commentator --format=json --lang=java filename.java
```

## SDK usage

TODO: SDK usage

# References