带你了解壳脚本的编写规范?相信很多没有经验的人对此束手无策,为此本文总结了问题出现的原因和解决方法,通过这篇文章希望你能解决这个问题。
编写shell脚本的一些规范
解释器
壳脚本一般选择bash作为解释器,脚本开头应为
# !/bin/bash 或 # !/bin/sh
添加脚本版本和注释功能
在脚本的开头加注释,说明脚本作者,编写时间,脚本功能,最好可以加上脚本的版本号.shell中脚本注释用<代码> #> 代码,注释语句和<代码> #> 代码号之间有一个空格
# !/bin/bash #脚本版本 #脚本作者 #脚本时间 #脚本功能
添加脚本调试
通过<代码>设置> 代码命令添加脚本调试,如果报错,脚本直接退出,不继续执行,对于管道错误也可以直接退出
# !/bin/bash #脚本版本 #脚本作者 #脚本时间 #脚本功能 设置- e 设置- o pipfail
变量命名
变量命名要统一规范,壳变量建议使用全部大写,意思清晰明了,如果是多个字符,可以采用下划线进行切割,如<代码> APACHE_LOG_PATH> 代码,对于变量的引用可以直接使用<代码> 代码>美元,如果有下划线分区的变量,建议使用$ {APACHE_LOG_PATH} <代码> 代码>。
全局变量和局部变量
全局变量可以采用前面时候的定义方式,如果是函数中的局部变量,建议使用当地<代码> 代码>进行变量声明,这个防止全局变量和局部变量混淆,局部变量可以采用小写,用来区分局部变量和全局变量。
函数TestFunc () { 本地名称=& # 39;xiaolangjun& # 39; echo ${名称} }
如果存在变量合并的情况,比如目录和文件名合并,这样可以重新赋值成一个新的变量,这样方便以后调用。
命名规范
函数命名
函数命名一般单词的首字母大写,比如<代码> GetInformation> 代码,意思清晰。
- <李>获取最大值或最小值时后缀使用<代码> Max 代码>,<代码> Min 代码> 李> <李>获取信息或者返回值的函数可以使用<代码>得到> 代码作为前缀李> <李>判断函数可以使用<代码>是代码>作为前缀李>
脚本命名
脚本命的名,根据脚本功能进行命名,后缀为<代码>。sh> 代码,如果在脚本运行过程中产生一些临时文件,建议采用PID为后缀,如果脚本运行完成,这个文件没有用途,则自动进行删除。
PID=$ $ TMP_FILE=癷p_list"。$ {PID}
函数
- <李>函数定义,建议添加<代码> 代码>函数关键字李> <>李函数中缩进可以使用4个空格李> <>李函数中使用判断或者循环语句,使用统一风格,不要有的换行,有的不换行李> <李>多管道语句,建议可以进行拆分,增加可读性,可以将通用部分提取李> <李>使用<代码>,和代码>或<代码> | |> 代码可以简化判断语句,语义更加清晰李>
引用模块或文件
引用脚本或者模块文件时,添加注释,简要说明模块的主要功能和作用,使用<代码>。代码>或者<代码>源代码>
脚本日志
脚本中建议添加日志函数,这样方便脚本调试,脚本运行中各函数的输出和状态,日志文件中包括时间,日志级别——函数,日志创建日志目录,有常规的日志和错误日志。
配置文件
在工程目录下创建之目录,配置文件以. conf为后缀,配置字段要风格统一,每个配置提供相关配置注释
其他
- <李>脚本中路径变量,建议使用绝对路径,最后面不要使用/结尾,例如:<代码> LOG_DIR=?var/log" 代码> 李> <李>
李>
看完上述内容,你们掌握带你了解壳脚本的编写规范的方法了吗?如果还想学到更多技能或想了解更多相关内容,欢迎关注行业资讯频道,感谢各位的阅读!