这是陈树义的第
035期分享
作者 l 陈树义
来源 l 陈树义(ID:Spark-tree)
转载请联系授权(ID:Spark-tree)
一个 Shell 脚本都以为文件名后缀,并且其文件结构都有一定的特点。一个标准的 Shell 脚本范例如下:
文件标识。第一行的是一个特殊标记(一般称为Hashbang),标识该 Shell 脚本将使用这个 Shell 对这个文件内容进行解析。
文件注释。这部分是对这个文件业务逻辑的注释,一个好的注释可以让别人一眼看懂该文件的目的。
Shell代码。这部分就是具体的业务代码了。
在注释部分,建议分为两个部分:
顶层注释。顶层注释主要是对其内容进行简要概述。版权声明和作者信息是可选的。例如:
功能注释。其他人通过阅读注释就能够学会如何使用你的程序或库函数,而不需要阅读代码。例如:
综合以上的建议,整理了一个 Shell 脚本的文件结构范例。下次你要写 Shell 脚本的时候可以直接拷贝过去,修改相关注释以及函数名就可以,即规范又简便。
↓看了这么久了,点个赞再走呗。↓
领取专属 10元无门槛券
私享最新 技术干货