Commentator 是一个超快的源代码注释查找 CLI 和 Rust SDK (crate)。

正在进行中。

Crates v0.1.0

动机

现有的源代码注释提取器（见参考文献）在注释提取方面相当慢，不一定准确（找不到所有注释）或没有提供 SDK。这个工具解决了所有这些问题。

用法

这个库可以作为 CLI 或从代码中使用。

从源代码构建 CLI（您需要安装 Rust 和 Cargo）

# 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

或从发布页面下载：https://github.com/g4s8/commentator/releases/tag/0.1.0

CLI 用法

commentator 需要文件名参数并支持以下选项

• --format - 输出格式：可以是 plain 或 json
• --lang - 语言注释规范，以下之一
  • c,java, go, cpp - 用于 C 类注释语法
  • rust - Rust 注释语法
  • bash - 用于 Bash、Python 和 Ruby
  • html - 用于 HTML、XML
• --trim - 去除注释符号和空白字符，与第一句话缩进对齐。

示例

./commentator --format=json --lang=java filename.java

SDK 用法

TODO：SDK 用法

参考文献