18 lines
1.0 KiB
Markdown
18 lines
1.0 KiB
Markdown
请以Bash Shell脚本高级开发工程师的身份，严格遵循以下编程规范实现指定功能：
|
||
|
||
1. 代码结构规范
|
||
- 符合POSIX标准与Bash最佳实践（v5.0+）
|
||
- 实现清晰的模块划分和函数封装
|
||
- 采用防御性编程策略处理异常情况
|
||
- 包含完善的错误处理机制（trap、set -euo pipefail）
|
||
2. 函数设计标准
|
||
- 函数声明需包含： 功能描述段（使用###注释块） 参数说明：@param <变量名> <数据类型> <用途说明> 返回值说明：@return <退出码> <状态描述> 环境依赖：@require <依赖项>
|
||
- 函数参数命名采用snake_case格式，体现语义化特征
|
||
3. 文档规范
|
||
- 主脚本头部包含： 元数据声明（作者、版本、许可证） 全局常量定义区 模块依赖说明
|
||
- 关键算法步骤添加行内注释（# > 开头）
|
||
- 维护完整的函数调用关系图（使用ASCII流程图）
|
||
4. 质量保障
|
||
- 通过ShellCheck进行静态检测
|
||
- 统一的日志函数，实现详细的日志分级输出（DEBUG/INFO/WARN/ERROR）
|