配置文件x.toml注释形式

Posted on Views:

在 .toml（Tom’s Obvious, Minimal Language）配置文件中，**注释只支持一种形式：使用 #**。

1. 单行注释

1
2
# 这是一个注释
key = "value"  # 行尾注释
  • # 后面的内容都会被忽略
  • 支持独立一行或行尾注释

2. toml不支持多行注释

2.1不支持多行注释

1
2
3
4
# ❌ TOML 没有这种写法
/*
multi line
*/

2.2连续块正确注释语法

1
2
3
4
# 正确方式（逐行注释）
# line1
# line2
# line3

3. 最佳实践

  • 配置说明建议结构化：
1
2
3
4
5
6
# ======================
# Redis 配置
# ======================
[redis]
host = "127.0.0.1"
port = 6379
  • 关键参数必须带注释（避免运维误操作）
1
2
# 是否开启 debug（生产必须关闭）
debug = false
  • 敏感配置标识清晰
1
2
# ⚠️ 敏感信息：不要提交到 Git
password = "xxx"