Markdownコードブロック

コードブロックは、技術文書、チュートリアル、コード例を含むあらゆるコンテンツにとって不可欠です。Markdownは、シンプルなインラインコードから構文ハイライト付きの完全なコードブロックまで、コードをフォーマットするための複数の方法を提供します。

インラインコード

文中での短いコードスニペットには、単一のバッククォートを使用します：

`git status`コマンドを使用してリポジトリを確認します。
`console.log()`関数はコンソールに出力します。
`Ctrl+C`を押してプロセスを停止します。

結果:

git statusコマンドを使用してリポジトリを確認します。 console.log()関数はコンソールに出力します。 Ctrl+Cを押してプロセスを停止します。

フェンスコードブロック

複数行のコードには、3つのバッククォートを使用します：

```
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

トラブルシューティング

よくある問題

コードがフォーマットされない: 適切なバッククォートを確認

構文ハイライトが動作しない: 言語識別子を確認
コードがレイアウトを破る: 適切な改行を使用

バッククォートのエスケープ

コードでバッククォートを表示する必要がある場合：

単一バッククォートの例:

•
書く: `コード`
•
結果: コード

3つのバッククォートの例:

•
書く: ```コードブロック```
•
結果: コードブロック

インラインコード内のバッククォート:

•
書く: ``バッククォート``
•
結果: バッククォート

コードブロックは技術文書にとって不可欠です。コード例を明確で読みやすく、適切にフォーマットされたものにするために使用してください！

最後に、テキストフォーマットを完成させるために改行について学びましょう。