详解shell脚本的编写规范

2023-07-13 01:05:03 62

编写shell脚本的一些规范

shell脚本一般选择bash作为解释器，脚本开头应为

#!/bin/bash
或
#!/bin/sh

在脚本的开头加注释，说明脚本作者、编写时间、脚本功能，最好可以加上脚本的版本号。shell中脚本注释用#，注释语句和#号之间有一个空格

#!/bin/bash

#脚本版本
#脚本作者
#脚本时间
#脚本功能

通过set命令添加脚本调试，如果报错，脚本直接退出，不继续执行，对于管道错误也可以直接退出

#!/bin/bash

#脚本版本
#脚本作者
#脚本时间
#脚本功能

set-e
set-opipfail

变量命名要统一规范，shell变量建议使用全部大写，意思清晰明了，如果是多个字符，可以采用下划线进行切割，如APACHE_LOG_PATH，对于变量的引用可以直接使用$，如果有下划线分区的变量，建议使用${APACHE_LOG_PATH}。

全局变量和局部变量

全局变量可以采用前面时候的定义方式，如果是函数中的局部变量，建议使用local进行变量声明。这个防止全局变量和局部变量混淆，局部变量可以采用小写，用来区分局部变量和全局变量。

functionTestFunc(){
	localname='xiaolangjun'
	echo${name}
}

如果存在变量合并的情况，比如目录和文件名合并，这样可以重新赋值成一个新的变量，这样方便以后调用。

函数命名一般单词的首字母大写，比如GetInformation，意思清晰。

脚本命名，根据脚本功能进行命名，后缀为.sh，如果在脚本运行过程中产生一些临时文件，建议采用PID为后缀，如果脚本运行完成，这个文件没有用途，则自动进行删除。

PID=$$
TMP_FILE="ip_list".${PID}

引用脚本或者模块文件时，添加注释，简要说明模块的主要功能和作用，使用.或者source

脚本中建议添加日志函数，这样方便脚本调试，脚本运行中各函数的输出和状态，日志文件中包括时间-日志级别-函数，日志创建log目录，有常规的log和错误log。

在工程目录下创建conf目录，配置文件以.conf为后缀，配置字段要风格统一，每个配置提供相关配置注释

其他

到此这篇关于编写shell脚本的规范的文章就介绍到这了,更多相关shell脚本编写规范内容请搜索毛票票以前的文章或继续浏览下面的相关文章希望大家以后多多支持毛票票！