代码规范之shell

代码规范

---

1. 介绍

为什么要有代码规范？
代码写给谁看？
别人的代码你看的懂吗？

2. 代码可维护性

简明，易懂
有必要的注释
保持风格一致

3. 代码规范内容

3.1 命名

- 文件命名
- 函数命名：和实现功能一致
 小写， 动词_名词， 如:search_key, download_zone
- 全局变量命名:有意义
  大写 以下划线连接：YETI_SERVERS
- 局部变量命名
   小写，短促，能够精确表达意思

3.2 代码缩进与对齐方式

1. 函数体：
   4个空格， 每行80个字符，长度控制在50行之内
   不同功能块之间用空行隔开
2. if, while, for，case: 4个空格缩进

3.3 注释

1. 每个脚本文件功能注释: 解释脚本是干什么用的

   #!/bin/bash
   #
   # Perform hot backups of Oracle databases.

2. 每个函数功能注释： 介绍函数的功能
3. 关键流程注释

3.4 模块化

1. 函数功能单一： 只做一件事
2. 传递参数
3. 无硬编码
4. 去除重复代码
5. 尽量使用局部变量
6. 尽量传递参数， 少用全局变量
7. 保持代码简单， 简短

4. 函数测试

对每个功能点进行完整测试
测试各种异常情况：
1. 网络异常
2. 硬盘写满
对返回值进行检查
确保函数的功能完整实现
测试用例必须可以重复执行

5. 日志处理

调试日志
记录关键执行流程日志
关键错误报警， 频率
日志输出：syslog， 文件记录

6. 常用调试技巧

1. 打印变量值
  查看是否获取到需要的值
2. 包装日志输出函数： 
    打印执行时间，文件名，函数名，出错行数等
3. 关键流程日志输出到文件中

7. 常用代码片段

1. 参数解析：

8. 找到问题根源

9. 参考文档

1. google shell style