Markdown程式碼區塊

程式碼區塊對於技術文件、教學和包含程式碼範例的任何內容都是必不可少的。Markdown提供了多種格式化程式碼的方法，從簡單的內聯程式碼到具有語法高亮的完整程式碼區塊。

內聯程式碼

對於句子中的短程式碼片段，使用單個反引號：

使用`git status`指令檢查您的儲存庫。
`console.log()`函式輸出到主控台。
按`Ctrl+C`停止程序。

結果：

使用git status指令檢查您的儲存庫。 console.log()函式輸出到主控台。按Ctrl+C停止程序。

圍欄程式碼區塊

對於多行程式碼，使用三個反引號：

```
function greet(name) {
  console.log("Hello, " + name + "!");
}

greet("World");
```

結果：

function greet(name) {
  console.log("Hello, " + name + "!");
}

greet("World");

語法高亮

在開始反引號後添加語言名稱以進行語法高亮：

JavaScript

```javascript
function calculateSum(a, b) {
  return a + b;
}

const result = calculateSum(5, 3);
console.log(result); // 輸出：8
```

Python

```python
def calculate_sum(a, b):
    return a + b

result = calculate_sum(5, 3)
print(result)  # 輸出：8
```

常用語言識別碼

語言	識別碼	替代
JavaScript	`javascript`	`js`
Python	`python`	`py`
Java	`java`
C++	`cpp`	`c++`
C#	`csharp`	`cs`
HTML	`html`
CSS	`css`
SQL	`sql`
JSON	`json`
XML	`xml`
Shell	`bash`	`sh`
TypeScript	`typescript`	`ts`
React JSX	`jsx`
PHP	`php`
Go	`go`
Rust	`rust`
Swift	`swift`

重要說明

圍欄程式碼區塊是在Markdown中格式化程式碼的首選方法，因為它們提供更好的語法高亮，並且在不同平台上得到更廣泛的支援。

最佳實務

1. 始終使用語法高亮

❌ 無語法高亮：

```
if (user.isLoggedIn) {
  showDashboard();
} else {
  showLoginForm();
}
```

✅ 有語法高亮：

```javascript
if (user.isLoggedIn) {
  showDashboard();
} else {
  showLoginForm();
}
```

2. 保持程式碼範例專注

❌ 太多無關程式碼：

```javascript
// 大量設定程式碼...
const express = require('express');
const app = express();
const PORT = 3000;

// ... 更多設定 ...

// 實際範例（埋在設定中）
app.get('/api/users', (req, res) => {
  res.json({ users: [] });
});

// ... 更多樣板程式碼 ...
```

✅ 專注於重要部分：

```javascript
// 建立簡單的API端點
app.get('/api/users', (req, res) => {
  res.json({ users: [] });
});
```

常見使用案例

API文件

請求：

POST /api/users
Content-Type: application/json

{
  "name": "張三",
  "email": "[email protected]"
}

回應：

{
  "id": 123,
  "name": "張三",
  "email": "[email protected]",
  "created_at": "2024-01-15T10:30:00Z"
}

設定檔

在專案根目錄建立.env檔案：

# 資料庫設定
DB_HOST=localhost
DB_PORT=5432
DB_NAME=myapp
DB_USER=postgres
DB_PASSWORD=password123

# API金鑰
API_KEY=your_api_key_here
SECRET_KEY=your_secret_key_here

故障排除

常見問題

程式碼不格式化：檢查正確的反引號

語法高亮不運作：驗證語言識別碼
程式碼破壞版面配置：使用適當的換行

轉義反引號

如果需要在程式碼中顯示反引號：

單個反引號範例：

•
寫：`程式碼`
•
結果：程式碼

三個反引號範例：

•
寫：```程式碼區塊```
•
結果：程式碼區塊

內聯程式碼中的反引號：

•
寫：``反引號``
•
結果：反引號

程式碼區塊對技術文件至關重要。使用它們讓您的程式碼範例清晰、可讀且格式良好！

最後，讓我們學習換行來完善您的文字格式。