bashdoc

BashDoc

一个用于为任何目录或文件（使用6个通用分隔符定义）生成文档/帮助菜单的工具

语法

示例

使用类似于以下语法

#;
# cd()
# moves to given directory
# @param directory: folder to move to
# @return void
#"
cd() {
   cd $1
}

在我的 zshrc 中输出

带有许多颜色！

全局分隔符

默认分隔符如下

START_DELIM = #;

END_DELIM = #"

PAR_DELIM = @参数

RET_DELIM = @返回值

OPT_DELIM = # -

COMM_DELIM = #

这些可以在你的 .bashdocrc 中修改。

安装

cargo install bashdoc

或从源代码

注意：必须使用 Rust 2018 版本

使用 rustup update stable 更新

git clone https://github.com/dustinknopoff/bashdoc
cd bashdoc
cargo install --path . --force

用法

bashdoc 0.4.10
Creates a "javadoc" like structure for bash. See github repo github.com/dustinknopoff/bashdoc for information on formatting.

USAGE:
bashdoc [FLAGS] [OPTIONS] <INPUT> [SUBCOMMAND]

FLAGS:
-c, --color      toggles color
-h, --help       Prints help information
-V, --version    Prints version information
-w, --watch      continuously update on change

OPTIONS:
-j, --json <FILE>            print result as JSON
-l, --location <location>    location to save HTML
-t, --template <template>    .hbs template to use for generation of documentation

ARGS:
<INPUT>    Sets the input file or glob pattern to use

SUBCOMMANDS:
help        Prints this message or the help of the given subcommand(s)
override    override the delimiters

请参阅 示例 目录以获取更多信息。

请参阅 变更日志 了解更新。

变更日志

• v0.4.0 - 添加到 crates.io
• v0.4.1/v0.4.2 - 更好的 crates.io 描述
• v.0.4.5 - 修复了 bashdoc 对于没有 ~/.bashdocrc 的用户不工作的问题
• v.0.4.6 - 改进错误处理，删除了 --html 参数，并用 --location 替换，添加了 --template 参数以提供自定义的 .hbs
• v0.4.7 - 修复了所有输入都需要的位置，而不只是 --location
• v0.4.8 - 更清晰的 README，链接到 docs.rs 文档
• v0.4.9 - 改进错误路径处理
• v0.4.10 - 再次支持 Windows 文件路径
• v0.4.11 - 在目录内支持覆盖全局 .bashdocrc
• v0.4.12 - 描述符可以用冒号或空格分隔
• v0.5.0 - 重构以改进错误处理和 rust-ic 代码

许可证：MIT