跳到主要内容

Markdown 代码块指南

提示

掌握 Markdown 代码块的使用可以让你的文档更加专业和易读。

基本语法​

1. 行内代码​

使用单个反引号: code

2. 代码块​

使用三个反引号:

// 基本代码块
function example() {
    return "Hello World";
}

3. 语法高亮​

指定语言:

// JavaScript 示例
function greet(name) {
    return `Hello, ${name}!`;
}

支持的语言​

1. 常用语言​

const add = (a, b) => a + b;

2. 标记语言​

<!-- HTML -->
<div class="example">
    <p>示例文本</p>
</div>
/* CSS */
.example {
    color: #333;
    padding: 20px;
}

3. 配置文件​

# YAML
version: 1.0
settings:
  theme: dark
  language: zh
// JSON
{
  "version": "1.0",
  "settings": {
    "theme": "dark",
    "language": "zh"
  }
}

高级功能​

1. 行号​

添加行号:

function example() {
    const x = 1;
    const y = 2;
    return x + y;
}

2. 高亮行​

突出显示特定行:

def important_function():
    # 这行不会高亮
    # 这行会高亮
    return "高亮示例"

3. 标题​

添加文件名:

example.js
// 这是一个带标题的代码块
console.log("Hello World");

最佳实践​

1. 代码格式化​

保持一致的格式:

// 好的格式
function goodFormat() {
    const data = {
        key: "value",
        number: 42
    };
    return data;
}

// 避免的格式
function badFormat(){
const data={key:"value",number:42};
return data}

2. 注释使用​

添加有用的注释:

# 好的注释
def process_data(data):
    # 验证输入数据
    if not data:
        raise ValueError("数据不能为空")
    
    # 处理数据
    result = data.copy()
    
    # 返回处理后的结果
    return result

3. 错误处理​

展示错误处理:

try {
    // 可能出错的代码
    riskyOperation();
} catch (error) {
    // 错误处理
    console.error("发生错误:", error);
} finally {
    // 清理代码
    cleanup();
}

特殊用例​

1. 命令行​

# 命令行示例
$ npm install package-name
$ git commit -m "提交信息"

2. 数据库查询​

-- SQL 查询示例
SELECT name, age
FROM users
WHERE age > 18
ORDER BY name;

3. 正则表达式​

# 正则表达式示例
^[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2,}$

交互式示例​

1. REPL 会话​

> const x = 10
undefined
> x * 2
20
> console.log("结果:", x)
结果: 10
undefined

2. 调试输出​

>>> import datetime
>>> print(datetime.datetime.now())
2025-03-08 12:34:56

3. 控制台输出​

$ python script.py
开始执行...
处理数据...
完成！

相关资源​