巴什多克
bash应用程序的文档生成器。
文档语法
Bashdoc将在源代码中评估一些特殊注释。 注释以以下文档字符串为前缀:
# mod: modname :模块名称本身。
# fun: funsignature :函数签名,通常在此处包含参数,但不对其进行描述。
# txt:上一个声明的部分(模块或函数)的文本描述。
# opt: param: ... :描述函数的选项或参数。
# env: VAR: ... :描述一个名为$VAR的环境变量。
# use: ... :提供使用功能或模块的示例。
# api: ... :设置此元素的API名称。 API名称可用于过滤最终输出中将记录哪些功能或模块。
例子
让我们假设文件script.bash的以下内容
# mod: example
# txt: this module is an example for documenta