​

密鑰佔位符慣例

​

建議樣式

• 偏好描述性值，例如 example-openai-key-not-real 或 example-discord-bot-token。
• 對於 shell 片段，偏好使用 ${OPENAI_API_KEY}，而不是內嵌看似權杖的字串。
• 讓範例明顯為假，且限定於用途範圍內（供應商、頻道、驗證類型）。

​

文件中應避免這些模式

• 文字形式的 PEM 私密金鑰標頭或結尾。
• 類似有效憑證的前綴，例如 sk-...、xoxb-...、AKIA...。
• 從執行階段記錄複製的、看起來逼真的 bearer 權杖。

​

範例

# Good
export OPENAI_API_KEY="example-openai-key-not-real"

# Better (when the doc is about env wiring)
export OPENAI_API_KEY="${OPENAI_API_KEY}"