如何向 .env 文件添加注释？

Question

我正在使用dotenv模块从.env文件加载环境变量。

.env：

# config
DAILY_REPORT_SCHEDULE='*/1 * * * *'
PORT=8080
NODE_ENV=development
DOTENV_DEBUG=true

# credentials
PROJECT_ID=shadowsocks-218808
KEY_FILE_NAME='/Users/ldu020/workspace/nodejs-gcp/.gcp/shadowsocks-218808-7f8e109f4089.json'

如您所见，我在.env文件中添加了两个注释。

dotenv.js：

require('dotenv').config({ debug: process.env.DOTENV_DEBUG === 'true' });

dotenv 给我调试信息：

# config
DAILY_REPORT_SCHEDULE='*/1 * * * *'
PORT=8080
NODE_ENV=development
DOTENV_DEBUG=true

# credentials
PROJECT_ID=shadowsocks-218808
KEY_FILE_NAME='/Users/ldu020/workspace/nodejs-gcp/.gcp/shadowsocks-218808-7f8e109f4089.json'

我知道收到这些调试消息的原因是我在.env文件中添加了两条注释和一些新行。dotenv不能.env正确解析文件。

我该如何解决这个问题？

Answer 1

从 2019 年中期开始是可能的。

以#符号开始行。查看文档：

以# 开头的行被视为注释。

对于vlucas/phpdotenv也是同样的情况。

Answer 2

截至 2022 年 4 月 17 日，评论行和内嵌评论均可用。只需使用#.

无耻地从https://github.com/motdotla/dotenv#comments复制：

# Comment
SECRET_KEY=YOURSECRETKEYGOESHERE # Comment
SECRET_HASH="something-with-a-#-hash"