快速给shell脚本加上使用提示

我们只需通过在shell脚本前面加上如下的代码即可：

#!/bin/bash
###
### my-script — does one thing well
###
### Usage:
###   my-script <input> <output>
###
### Options:
###   <input>   Input file to read.
###   <output>  Output file to write. Use '-' for stdout.
###   -h        Show this message.

help() {
    sed -rn 's/^### ?//;T;p' "$0"
}

if [[ $# == 0 ]] || [[ "$1" == "-h" ]]; then
    help
    exit 1
fi

其中的说明Usage 和 Options选项可以依据自己脚本的功能进行相应的改变。

其中help()函数中的各个参数的具体含义是：

• $0表示你要执行的文件名称
• s 在sed中表示通过以下模式进行替换
• ^### ? 匹配以###开头的字符串，后面有可选空格
• // 用空字符替换###
• T 如果s///没有成功完成替换，则跳到脚本最后
• p 打印替换之后的结果