如何向 .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 给我调试信息：

[dotenv][DEBUG] did not match key and value when parsing line 1: # config
[dotenv][DEBUG] did not match key and value when parsing line 6:
[dotenv][DEBUG] did not match key and value when parsing line 7: # credentials
[dotenv][DEBUG] did not match key and value when parsing line 10:
[dotenv][DEBUG] did not match key and value when parsing line 11:

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

我该如何解决这个问题？

Answer 1

从 2019 年年中开始有可能。

以 # 符号开始该行。见 the docs:

lines beginning with # are treated as comments.

对于vlucas/phpdotenv同样的情况。

motdotla/dotenv.

肯定不支持内联注释

Answer 2

在# 或 ; 右侧的同一代码行中编写的所有内容是评论。

Answer 3

自 2022 年 4 月 17 日起，评论行和内联评论均可用。只需使用 #.

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

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

Answer 4

You can add a comment in .env by starting a line with a hash (#) symbol. E.g.

# host value
DB_HOST=host
# username
DB_USER=admin
# secure password
DB_PASS=pass

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

How to add comments to .env file?

node.js

dotenv