Shell脚本编程规范养成
创始人
2024-01-25 11:35:43
0

系列文章目录


Chapter1 Shell脚本入门
Chapter2 Shell脚本编程规范养成
Chapter3 Shell变量的定义及用法
Chapter4 Shell流程控制语句IF


文章目录

  • 系列文章目录
  • 前言
  • 一、常用规范
    • 1. 首行指定脚本解释器
    • 2. Shell脚本开头增加版本,版本信息
    • 3. Shell脚本中尽量不用中文(包括注释)
    • 4. Shell脚本的命名应以.sh为扩展名
    • 5. Shell脚本应存放在固定路径下
  • 二、Shell脚本代码书写的良好习惯
    • 1.成对的符号应一次性写出来
    • 2.中括号两端要至少有一个空格
    • 3.流程控制语句,一次性将格式写完,再添加内容。
    • 4.通过缩进让代码更易读
    • 5.常规变量赋值应加双引号
  • 总结


前言

Shell脚本的开发规范及习惯非常重要,虽然这些规范不是必须要遵守的,但有了好的规范和习惯,可以大大提升开发效率,并能在后期降低对脚本的维护成本,当多人协作开发时,大家有一个互相遵守的规范就显得尤为重要。即使一个人开发,最好也采取一套固定的规范,这样脚本就会更易读、更易于后期维护。最重要的是让自己养成一个一出手就很专业和规范的习惯。


一、常用规范

1. 首行指定脚本解释器

#!/bin/bash

2. Shell脚本开头增加版本,版本信息

#!/bin/bash
# Date:		2022-11-16
# Author:	Created by yanjianjun
# Blog:		https://blog.csdn.net/weixin_43770382
# Description:This scripts function is ...
# Version:	1.0

上述内容可修改“~/.vimrc”配置文件,当执行vim编辑文件时自动加上以上信息的功能。后面讲到时,再说。

3. Shell脚本中尽量不用中文(包括注释)

尽量使用英文注释,防止本机或切换系统环境后中文乱码的困扰。

4. Shell脚本的命名应以.sh为扩展名

例如:script-name.sh

5. Shell脚本应存放在固定路径下

按照管理,普通用户的脚本,建议放在~/bin目录下,root用户的脚本建议放在/usr/local/bin目录中。RHEL系操作系统,上述两个目录默认存在于$PATH路径中,执行脚本时,写全路径或脚本名称都可以正常执行。

二、Shell脚本代码书写的良好习惯

1.成对的符号应一次性写出来

成对的符号一次性写出来,然后退格在符号里增加内容,防止遗漏。成对的符号包括:

	{ }、[ ]、“ ”、’ ‘、` `、[[  ]]

2.中括号两端要至少有一个空格

键入中括号时两端即可流出空格[ ],然后再退格键入中间的内容,双中括号([[ ]])也是是如此。

3.流程控制语句,一次性将格式写完,再添加内容。

if expression; thencommand
fifor expression; do内容
done

while、until、case等语句也是一样。

4.通过缩进让代码更易读

if expression; thencommand1
elif expression; thencommand2
elsecommand3
fi

5.常规变量赋值应加双引号

常规变量赋值应加双引号(" "),并且等号前不能有空格。需要强引用的,指所见即所得的字符引号,使用单引号(’ '),如果是命令引用,则用反引号( ).

FILE="iplist"

注意:脚本中的单引号、双引号及反引号必须为英文状态下的符号。


总结

有关Shell脚本开发规范及习惯的更多内容,持续更新,未完待续。

相关内容

热门资讯

AWSECS:访问外部网络时出... 如果您在AWS ECS中部署了应用程序,并且该应用程序需要访问外部网络,但是无法正常访问,可能是因为...
AWSElasticBeans... 在Dockerfile中手动配置nginx反向代理。例如,在Dockerfile中添加以下代码:FR...
银河麒麟V10SP1高级服务器... 银河麒麟高级服务器操作系统简介: 银河麒麟高级服务器操作系统V10是针对企业级关键业务...
北信源内网安全管理卸载 北信源内网安全管理是一款网络安全管理软件,主要用于保护内网安全。在日常使用过程中,卸载该软件是一种常...
AWR报告解读 WORKLOAD REPOSITORY PDB report (PDB snapshots) AW...
AWS管理控制台菜单和权限 要在AWS管理控制台中创建菜单和权限,您可以使用AWS Identity and Access Ma...
​ToDesk 远程工具安装及... 目录 前言 ToDesk 优势 ToDesk 下载安装 ToDesk 功能展示 文件传输 设备链接 ...
群晖外网访问终极解决方法:IP... 写在前面的话 受够了群晖的quickconnet的小水管了,急需一个新的解决方法&#x...
不能访问光猫的的管理页面 光猫是现代家庭宽带网络的重要组成部分,它可以提供高速稳定的网络连接。但是,有时候我们会遇到不能访问光...
Azure构建流程(Power... 这可能是由于配置错误导致的问题。请检查构建流程任务中的“发布构建制品”步骤,确保正确配置了“Arti...