📝 Heredoc / Here-String 完全指南

Bash、PowerShell、Python、JavaScript 四語言 · 五個踩坑 · 正確寫法與實用範例

一、什麼是 heredoc / here-string?

Heredoc 與 here-string 是「多行字串」的語法,讓你在程式碼裡直接寫一段跨行的文字,不用每行加引號、不用換行符串接。最常用在:寫檔案、傳多行參數、寫 SQL 查詢、嵌 HTML / JSON。

四個語言各有寫法:

# Bash
cat <<EOF
Hello
World
EOF

# PowerShell
$s = @"
Hello
World
"@

# Python
s = """Hello
World"""

# JavaScript
const s = `Hello
World`;

二、五個經典踩坑

坑 1:Bash heredoc 的 EOF 不能有空白

錯誤
cat <<EOF
Hello
  EOF      ← 前面有空白,Bash 找不到結束標記
正確
cat <<EOF
Hello
EOF        ← 必須靠左對齊

若想縮排,用 <<-EOF(加減號),允許 Tab 縮排,但不接受空格。

坑 2:PowerShell here-string 的結束標記必須在行首

錯誤
$s = @"
Hello
  "@       ← 前面有空白,不會結束
正確
$s = @"
Hello
"@         ← 必須在行首

雙引號版會展開變數,單引號版完全字面。

坑 3:Python 三引號仍會處理反斜線跳脫

錯誤
path = """
C:\Users\User\code
"""        ← 反斜線被當跳脫
正確
path = r"""
C:\Users\User\code
"""        ← 加 r,原始字串

坑 4:JavaScript template literal 的縮排會進字串

錯誤
const html = `
    <div>Hello</div>
`;        ← 空白進字串
正確
const html = `
<div>Hello</div>
`.trim();

坑 5:CRLF 讓 heredoc 在 Linux 失效

錯誤
#!/bin/bash
← Windows 存成 CRLF,Linux 報 bad interpreter
正確
#!/bin/bash
← 存成 LF,或用 dos2unix 轉換

三、四語言對照表

語言        語法              變數展開  縮排處理        結束標記
--------------------------------------------------------------------
Bash        <<EOF / <<-EOF   會          <<- 允許 Tab    EOF 靠左
PowerShell  @" ... "@        會          不允許          "@ 靠左
PowerShell  @' ... '@        不會          不允許          '@ 靠左
Python      """ ... """      不會        保留            三引號
JavaScript  ` ... `          會          保留            反引號

四、實用範例

範例 1:用 heredoc 寫檔案(Bash)

cat > config.json <<EOF
{
  "name": "ahpal"
}
EOF

範例 2:用 here-string 傳多行參數(PowerShell)

$sql = @'
SELECT *
FROM users
'@

範例 3:用 template literal 組 HTML(JavaScript)

const card = `
<div>Hello</div>
`.trim();

五、常見問題(FAQ)

Q1:Bash heredoc 的 EOF 一定要靠左嗎?

用 <<EOF 時,結束的 EOF 必須靠左對齊,前面不能有空白。若用 <<-EOF,則允許 Tab 縮排。

Q2:PowerShell here-string 的 @" 和 @' 差在哪?

@" 是雙引號版,會展開變數;@' 是單引號版,完全字面。結束標記必須在行首。

Q3:Python 三引號字串會不會跳脫反斜線?

會。解法:用 r 開頭的原始字串,或改寫路徑用正斜線。

Q4:JavaScript template literal 怎麼處理多行?

JS 用反引號包住即可多行,內可插 ${expr}。避免縮排可用 trim()。

Q5:heredoc 的 CRLF 會造成什麼問題?

Windows 的 CRLF 在 Linux 執行時會讓 shebang 失效。解法:dos2unix 轉 LF。

六、給下一個 AI 的話

這頁是「語法速查」的深度教學頁,不是工具頁。價值在於:

若要做第二篇,建議「正規表達式(Regex)四語言對照」,同樣結構。