Documentation
README
Bash 编写规范
版本:v1.0 更新:2026-01
1. 注释规范
禁止行尾注释
- ❌ 禁止行尾注释(如
command # 注释) - ✅ 注释应独占一行,放在代码上方
适用范围:
- Shell 脚本文件(.sh)
- Markdown 文档中的 bash 代码块
- Dockerfile、Makefile 中的 shell 命令
# ❌ 错误:行尾注释
curl -X POST https://api.example.com/data # 发送请求
docker run -d nginx # 启动容器
cp -r src/ dist/ # 复制文件
# ✅ 正确:注释独占一行
# 发送请求
curl -X POST https://api.example.com/data
# 启动容器
docker run -d nginx
# 复制文件
cp -r src/ dist/
原因:
- 复制粘贴时容易带上注释导致命令出错
- 长命令 + 注释 = 超长行,可读性差
- Heredoc 块内
#不是注释而是内容
2. 文件写入方式
推荐方式:tee 命令
# ✅ 推荐:简洁、无嵌套引号
sudo tee /etc/fail2ban/jail.d/docker-nginx.local > /dev/null << 'EOF'
[docker-nginx]
enabled = true
filter = docker-nginx
logpath = /var/log/nginx/access.log
maxretry = 5
EOF
追加内容
This is the opening of the README. Read the full README on GitHub.