shell 脚本规范
shell 脚本规范
一、背景
1.使用哪一种shell?
必须使用bash shell
2.什么时候使用shell?
- 数量相对较少的操作
- 脚本文件少于100行
3.脚本文件扩展名是什么?
shell脚本不要求有扩展名,或者以.sh结尾,库文件必须以.sh结尾,并且不可执行。
二、环境
STDOUT vs STDERR
所有的错误信息都应该被导向STDERR。
err() {
echo "[$(date +'%Y-%m-%dT%H:%M:%S%z')]: $@" >&2
}
if ! do_something; then
err "Unable to do_something"
exit "${E_DID_NOTHING}"
fi
三、注释
1.文件头注释
每一个文件的开头必须对文件进行描述
基本格式:
#!/bin/bash
# Date :
# Auth :
# E-mail:
# 功能描述
2.功能注释
任何函数及库函数无论长短都必须注释。
3.实现部分注释
注释较复杂、不易阅读、重要的部分
四、格式
1. 缩进
缩进4个空格,不允许使用制表符
2. 行的长度
每行最大长度为80个字符
3. 管道
如果一行容不下整个管道,把整个管道分割成每一行一个管道。
该规则同样适用于 || 和 &&
# Long commands
command1 \
| command2 \
| command3 \
| command4
4.循环
将 ; do , ; then 和 while , for , if 放在同一行,else单独一行。
if condition ;then
command
else
command
fi
5.case
如果命令只有一行,命令可以和;放在一行,其他情况下;单独一行。
case "${expression}" in
a)
command
;;
absolute)
command
;;
*)
command
;;
esac
6.变量
除了单个字符的特殊变量和定位变量之外,其他变量在引用时必须用{}括起来
除了特殊情况下使用$*,其他情况都必须使用$@
五、特性和BUG
1. 命令替换
使用 $(command) 而不是command
2. test,[和[[
必须使用[[
在 [[ 和 ]] 之间不会有路径名称扩展或单词分割发生,所以使用 [[ ... ]] 能够减少错误。而且 [[ ... ]] 允许正则表达式匹配,而 [ ... ] 不允许
3.测试字符串
使用 -z 或 -n 测试,不要使用 [[ "${my_var}" = "" ]]
4. eval
避免使用eval
六 命名规范
1.函数
- 函数名小写,并使用下划线分割单词
- 函数名和() 没有空格
- 大括号和函数名位于同一行
2.变量名
同函数名
3.常量和环境变量名
- 全部大写
- 下划线分割
4.源文件名
- 小写
- 需要分割使用下划线进行分割
5.只读变量
使用 readonly 或者 declare -r 来确保变量只读
6.本地变量
使用 local 声明特定功能的变量。声明和赋值应该在不同行。
7. 函数位置
所有函数放在常量下面
8.主函数,main
文件最后一行
main "$@"
七 命令调用
1.检查返回值
对于非管道命令,使用 $? 或直接通过一个 if 语句来检查以保持其简洁。
if ! mv "${file_list}" "${dest_dir}/" ; then
echo "Unable to move ${file_list} to ${dest_dir}" >&2
exit "${E_BAD_MOVE}"
fi
# Or
mv "${file_list}" "${dest_dir}/"
if [[ "$?" -ne 0 ]]; then
echo "Unable to move ${file_list} to ${dest_dir}" >&2
exit "${E_BAD_MOVE}"
fi
参考:
https://google.github.io/styleguide/shell.xml
shell 脚本规范的更多相关文章
- Shell编程-12-Shell脚本规范及调试
目录 Shell脚本规范 Shell脚本调试 Shell脚本规范 良好的代码规范不仅方便阅读,也利于维护和提升开发效率.因此建议大家在编写Shell脚本时养成良好的代码习惯.今天就和大家探讨一 ...
- 【Shell Basic】Shell脚本编写规范
shell脚本需要有较高的实用性.可维护.可阅读.方便他人阅读,因而需要建立一定的规范来操作 dream361@master:~$ cat test2.sh #!/bin/bash 所使用的bash程 ...
- 利用shell脚本生成CHANGELOG.md(包含git提交规范)
前言 我们经常看到github上面有很多CHANGELOG.MD包含版本的更新信息,如果我们的git提交能遵循一定的规范,那么使用gitlog就能很方便的生成它 生成结果  shell脚本 http ...
- Shell脚本开发规范
一.前言 由于工作需要,最近重新开始拾掇shell脚本.虽然绝大部分命令自己平时也经常使用,但是在写成脚本的时候总觉得写的很难看.而且当我在看其他人写的脚本的时候,总觉得难以阅读.毕竟shell脚本这 ...
- 【Shell脚本编程系列】Shell脚本开发的习惯和规范
1.开头指定脚本解释器 #!/bin/sh或#!/bin/bash 2.开头加版本版权信息 #Date #Author #Mail #Function #Version 提示:可配置vim编辑文件时自 ...
- 【Shell脚本编程系列】知识储备以及建立规范的脚本
前言 学习shell脚本编程需要的知识储备: vi/vim编辑器命令 vimrc设置要熟练 基础命令,100多个要熟练 基础和常用的网络服务命令要会:nfs . rsync. inotify . la ...
- Shell脚本编写规范
shell脚本需要有较高的实用性.可维护.可阅读.方便他人阅读,因而需要建立一定的规范来操作 dream361@master:~$ cat test2.sh #!/bin/bash 所使用的bash程 ...
- 编写Shell脚本的最佳实践,规范一
随着写的SHELL程序越来越多,发现自己每次写都有不同的习惯或者定义了不同的东西,变量名定义得不一样,整个程序缩进不统一,没有注释等问题,等我回过头看这些程序的时候发现很麻烦.所以写了个shell代码 ...
- 编写Shell脚本的最佳实践,规范二
需要养成的习惯如下: 代码有注释 #!/bin/bash # Written by steven # Name: mysqldump.sh # Version: v1.0 # Parameters : ...
随机推荐
- set unused
使用 set unused 选项标记不再使用的列 使用 drop unsused columns 丢弃标记为unused的列 alter table tabName set unused column ...
- B2C自营商城的订单设计方案
B2C自营商城的订单设计方案 2018年06月01日 17:19:00 lkx94 阅读数 1640 去年我们的美妆社区APP,上线了自有商城.之后经过多次版本迭代,商城系统的模块已经基本健全,值 ...
- LeetCode--047--全排列 II(java)
给定一个可包含重复数字的序列,返回所有不重复的全排列. 示例: 输入: [1,1,2] 输出: [ [1,1,2], [1,2,1], [2,1,1] ] 对比46题增加了used数组,判断该数上次是 ...
- python之requests模块中的params和data的区别
params的时候之间接把参数加到url后面,只在get请求时使用: import requests url='https://api.ireaderm.net/account/charge/info ...
- dede织梦5.7上传图片302以及Error #2038问题解决
dede织梦5.7上传图片302以及Error #2038问题解决 三月 19, 2012 · Posted in DEDE二次开发, PHP Number of View: 1388 在后台图片集 ...
- CF700E Cool Slogans 后缀自动机 + right集合线段树合并 + 树形DP
题目描述 给出一个长度为n的字符串s[1],由小写字母组成.定义一个字符串序列s[1....k],满足性质:s[i]在s[i-1] (i>=2)中出现至少两次(位置可重叠),问最大的k是多少,使 ...
- vue动态路由传值以及get传值及编程式导航
1.动态路由传值 1.配置路由处 { path: '/content/:id', component: Content }, // 动态路由 2.对应页面传值 <router-link :to= ...
- css选择器的组合示例
案例一demo <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://ww ...
- MatrixTraceTransform主要逻辑在transform方法中
@Override public void transform(TransformInvocation transformInvocation) throws TransformException, ...
- How to pass values across the pages in ASP.net without using Session
https://stackoverflow.com/questions/14956027/how-to-pass-values-across-the-pages-in-asp-net-without- ...