shell脚本注射方法以及命名规范

代码注释规范
代码文件注释
!#/bin/bash
脚本的参数
脚本的用途
脚本的用法及注意事项
脚本试用平台
脚本的写作时间，作者，版权等
各个函数前的说明注释
一些较复杂的单行命令注释
利用“#”对单行进行注释。
示例应用，新建文本，命名为test_single.sh 输入内容：

# 单行注释
echo '单行注释'
echo '123'
# echo '456'
echo '789'

执行结果：

【2】多行注释
（1）方式一

:<<!
# 注释内容块
！

示例应用，新建文本，命名为test_double_way1.sh 输入内容：

# 多行注释方式一
echo '多行注释方式一'
echo '456'
# echo '789'

:<<!
echo 'abc'
echo 'def'
echo 'hij'
!

echo '012'

执行结果：

（2）方式二

if false; then
# 注释内容块
fi

示例应用，新建文本，命名为test_double_way2.sh 输入内容：

# 多行注释方式二
echo '多行注释方式二'
echo '012'
# echo '345'

if false; then
echo 'abc'
echo 'def'
echo 'hij'
fi

echo '567'

（3）方式三

((0)) && {
# 注释内容块
}

示例应用，新建文本，命名为test_double_way3.sh 输入内容：

# 多行注释方式三
echo '多行注释方式三'
echo '678'
# echo '123'

((0)) && {
echo 'abc'
echo 'def'
echo 'hij'
}

echo '0123'

执行结果：

命名规范
变量命名
Bash 变量的定义规则：

变量名区分大小写，a和A为两个不同的变量。
变量名应以字母或下划线开头不能以数字开头且中间不能有空格
变量名与值之间的=两侧都不能有空格。
在读取或打印变量时，需使用$+变量名。
不能使用标点符号
不能使用bash里的关键字
名称长的变量尽量使用驼峰写法或者使用小写字母+下划线的方式进行命名
常量的定义推荐使用大写字母进行命名
在引用变量时为了避免不必要的麻烦，尽量使用${变量名}的方式进行引用

文件命名

1、通过脚本名称最好能够直接读出脚本的用途，
比如常用xx服务的启动脚本可命名为start_xx.sh，oo服务的监控脚本可命名
为oo_monit.sh，告警脚本可名称为abc_alert.sh
2、变量名字要有含义，不要拼错，尽量使用英文 
3、统一命名风格，用驼峰或者下划线连接，推荐使用小写字母加下划线的方式

bash在线工具
https://c.runoob.com/compile/18/