Lojidoc

关于

Lojidoc是一个用于创建Java项目Markdown文档的工具。程序解析源代码中的javadoc注释，并使用高级Java声明来为项目中的每个Java文件提供简洁且易于阅读的Markdown文档。

文档

源代码文档

贡献

欢迎提交拉取请求和功能请求。如果您正在打开一个问题，请使用提供的模板作为指南。有关贡献的更多信息，请阅读贡献指南。

安装

可以使用Cargo安装Lojidoc。以下包是安装所需的。

• rustc [安装]
• cargo [安装]

注意：cargo与rustc安装默认一起安装

可以使用以下命令安装Lojidoc：cargo install

$ cargo install lojidoc

安装后，可执行文件默认位置为~/.cargo/bin/lojidoc

从源码构建

$ git clone https://github.com/JoshBrudnak/Lojidoc.git
$ cd ./Lojidoc/
$ cargo build --release

使用方法

基本使用

$ lojidoc [Project_Path] [FLAGS] [OPTIONS]

示例用法

传递Lojidoc仓库URL和目标目录的示例

$ lojidoc ~/Project/src/java/ -c https://github.com/JoshBrudnak/Project/tree/master -d ~/docs/

使用lint选项查找javadoc错误并使用单个线程的示例

$ lojidoc ~/Project/src/java/ -l -s

注意：当使用lint标志时，Lojidoc不会生成任何Markdown文件

命令行参数