Markdown コード

Markdown は、シンプルなインラインコードから複雑なコードブロックまで、コードを表示するさまざまな方法を提供し、さまざまなシーンでのコード表示ニーズに応えます。


インラインコード

段落内の関数やコード断片は、バッククォートで囲むことができます(`)、例:

`printf()` 函数

表示結果は次のとおりです:

よく使う使用例:

  • 関数名:使用console.log()出力情報
  • 変数名:値を代入userName変数
  • コマンドライン:実行npm install依存関係のインストール
  • キーボードキー:押すCtrl+C内容をコピー
  • ファイル名:編集index.htmlファイル

特殊文字のエスケープ

インラインコード内でバッククォートやその他の特殊文字を表示する必要がある場合、エスケープ処理が必要です。

バッククォートを表示する方法:

単一バッククォートを二重バッククォートで囲む:

`` `バッククォート` を使用してコードを囲む``

レンダリング結果:

複数のバッククォートで囲む:

``` `` 二重バッククォート `` を含むコード```

レンダリング結果:

その他の特殊文字の処理:

  • HTML タグ:<div>要素
  • 数学記号:計算x + y = z
  • 特殊記号:使用&nbsp;スペースを表す

コードブロック

インデント式コードブロック

コードブロックは4つのスペースまたは1つのタブ文字(Tabキー)。

構文形式:

通常のテキスト段落

    これはインデントされたコードブロックです
    各行の前に4つのスペースがあります
    コードの元の形式を保持します
    
通常のテキストを続ける

例は次のとおりです:

表示結果は次のとおりです:

バッククォート3つのコードブロック

また、次を使うこともできます```コードを囲み、言語を指定します(指定しなくてもかまいません):

```
複数行のコード内容
空行を含めることができます
元のインデントを保持します
```

バッククォート3つ(```)は最も一般的なコードブロック構文であり、シンタックスハイライトと複数行のコード表示をサポートします。

```javascript
$(document).ready(function () {
    alert('サンプル');
});
```

表示結果は次のとおりです:

注意事項:

  • インデント式コードブロックの前後は空行で区切る必要があります
  • すべてのコード行は一貫したインデントを維持する必要があります
  • シンタックスハイライトはサポートされません
  • リスト内で使用する場合は8スペースのインデントが必要です

言語識別子とシンタックスハイライト

バッククォート3つの後に言語識別子を追加すると、シンタックスハイライト機能を有効にできます。

よく使う言語識別子の一覧:

  • javascript / js - JavaScript
  • python / py - Python
  • html - HTML
  • css - CSS
  • sql - SQL
  • json - JSON
  • xml - XML
  • yaml / yml - YAML
  • bash / shell- Shellスクリプト
  • java - Java
  • cpp / c++ - C++
  • csharp / c# - C#
  • php - PHP
  • ruby / rb - Ruby
  • go- Go言語
  • rust - Rust
  • typescript / ts - TypeScript

JavaScript:

```javascript
const users = [
    { name: "Alice", age: 25 },
    { name: "Bob", age: 30 }
];

const adults = users.filter(user => user.age >= 18);
console.log(adults);
```

Python:

```python
def calculate_area(radius):
    """计算圆的面积"""
    import math
    return math.pi * radius ** 2

# 使用函数
area = calculate_area(5)
print(f"圆的面积是: {area:.2f}")
```

SQL:

```sql
SELECT u.name, u.email, COUNT(o.id) as order_count
FROM users u
LEFT JOIN orders o ON u.id = o.user_id
WHERE u.created_at >= '2024-01-01'
GROUP BY u.id, u.name, u.email
ORDER BY order_count DESC
LIMIT 10;
```


コードブロックの高度な機能

行番号表示

一部のMarkdownレンダラーは行番号表示をサポートしており、特定の構文または設定によって実現されます。

構文例(一部サポート):

```javascript {.line-numbers}
function fibonacci(n) {
    if (n <= 1) return n;
    return fibonacci(n - 1) + fibonacci(n - 2);
}

console.log(fibonacci(10));
```

または次を使用:

```javascript showLineNumbers
const numbers = [1, 2, 3, 4, 5];
const doubled = numbers.map(x => x * 2);
const sum = doubled.reduce((a, b) => a + b, 0);
console.log(`总和: ${sum}`);
```

コード差分比較

コードの追加・削除・変更を表示するために使用され、バージョン管理における変更を示すためによく使われます。

Diff 構文:

```diff
function calculateTotal(items) {
-   let total = 0;
+   let total = 0.0;
    
    for (let item of items) {
-       total += item.price;
+       total += parseFloat(item.price);
    }
    
+   // 保留两位小数
+   total = Math.round(total * 100) / 100;
    return total;
}
```

Git スタイルの差分表示:

```diff
@@ -1,5 +1,8 @@
 function greetUser(name) {
-    console.log("Hello " + name);
+    if (!name) {
+        throw new Error("Name is required");
+    }
+    console.log(`Hello, ${name}!`);
 }
```

言語固有の差分比較:

```javascript
// 之前的代码
const oldFunction = () => {
    var x = 10;  // &#x274c; 使用 var
    console.log("Value: " + x);  // &#x274c; 字符串拼接
}

// 改进后的代码  
const newFunction = () => {
    const x = 10;  // &#x2705; 使用 const
    console.log(`Value: ${x}`);  // &#x2705; 模板字符串
}
```

その他の拡張