shell编程(四)语言编码规范之(注释)

规范考虑的方面：安全的角度、性能的角度、代码的可读性

最佳实践：针对bash语言编程中的'数据校验'、'加密和解密'、'脚本执行'、'目录或文件'操作，描述可能导致'安全漏洞或风险'的常见编码错误.

该规范旨在：'减少SQL注入'、'敏感信息泄露'、'环境变量攻击'、'临时文件攻击'等方面的安全问题

附加： 将'shell'脚本纳入git的版本控制;每次'修改'脚本,'保存'文件的时候自动修改'时间戳'

一    开始大餐

（1）注释

    1）幻数

#!/usr/bin/env bash

说明：解析器必须'位于首行'

原因：为了提高程序的'移植性','#!/usr/bin/env bash' 会自己判断使用的shell是什么,并加载相应的环境变量

    2）普通注释

普通注释以'#'开头即可，后续补充'注释的位置'

    3）脚本的头部注释

注释内容：'版本号'(最好进行版本控制)、'生成日期'、'作者'、'脚本功能'、'脚本使用方法'、'修改日志'

其中脚本的功能和使用方法的描述'必须清晰'

整体描述细节：注释关键字以"##开头",在关键字前加"@"

目的：方便生成统一的帮助文档'后续讲解如何生成'