文章首发于【陈树义的博客园】,点击跳转到原文:https://www.cnblogs.com/chanshuyi/p/quick_start_of_shell_03_file_structure.html
一个 Shell 脚本都以.sh
为文件名后缀,并且其文件结构都有一定的特点。一个标准的 Shell 脚本组成结构如下:
- 文件标识。第一行的
#!
是一个特殊标记(一般称为Hashbang),标识该 Shell 脚本将使用/bin/bash
这个 Shell 对这个文件内容进行解析。 - 文件注释。这部分是对这个文件业务逻辑的注释,一个好的注释可以让别人一眼看懂该文件的目的。
- Shell代码。这部分就是具体的业务代码了。
#!/bin/bash
# author:陈树义
# site:http://shuyi.me
echo "Hello Shell"
在注释部分,建议分为两个部分:
- 顶层注释。顶层注释主要是对其内容进行简要概述。版权声明和作者信息是可选的。例如:
#!/bin/bash
#
# 备份数据库User表
#######################################
# 连接指定数据数据库
# 全局变量:
# BACKUP_DIR
# ORACLE_SID
# 参数:
# None
# 返回值:
# None
#######################################
connect(){
}
综合以上的建议,整理了一个 Shell 脚本的文件结构范例。下次你要写 Shell 脚本的时候可以直接拷贝过去,修改相关注释以及函数名就可以,即规范又简便。
#!/bin/bash
#
# 备份数据库User表
#######################################
# 连接指定数据数据库
# 全局变量:
# BACKUP_DIR
# ORACLE_SID
# 参数:
# None
# 返回值:
# None
#######################################
connect(){
}