脚本规范书写使用手册v 1.0.01
需积分: 0 141 浏览量
2022-08-08
20:51:06
上传
评论
收藏 19KB DOCX 举报
介绍
在脚本开发中将常用信息规范化，统一使用标准模板，很大程度上降低重复 code 开发，
提高开发效率，减少维护脚本成本.
基本表规范
1. 函数定义完成,统一放置脚本前段,避免定义函数和执行其他流程混杂在一起,显得臃肿.
2. 返回码信息要统一规范书写，同样的异常描述信息使用一致描述.
3. 脚本命名根据功能要求命名，eg：redis_set_monitor 进行大 value 监控设置，可命
名:set_bigValue_monitor,仅是参照具体命名视功能而定.
4. 附上代码注释,方便快速明白具体实现内容.
5. 检查服务情况,可统一使用标准检查项封装成的函数用于检查:服务进程,检查用户,检查端
口号,检查进程所属用户组.
6. 细化执行失败场景,避免直接输出执行$? ≠0 信息,造成模糊界定,使异常返回码对应输
出信息不精确.
一、附属信息
1. #!/bin/bash 下空一行，如下
#!/bin/bash
#
2. 附上版本信息包括新增或优化迭代
eg：Version:1.0.0
小版本迭代请升到 Version:1.0.1
大版本迭代请升到 Version:1.1.0
版本优化项较多请升到 Version:2.0.0
3. 附上脚本功能描述信息，可以中文或英文，语言描述需要言简意赅，避免繁杂无法突出
重点.
信息包括：脚本作用，需要传入的参数，及注意事项或备注信息，其他辅助信息亦可。
4. 附上脚本执行方法
评论0