Markdown 行内代码与代码块

Markdown行内代码与代码块。

Markdown行内代码

在Markdown中,行内代码引用使用`包裹,语法如下:

Markdown行内代码

实例演示如下:

Markdown行内代码

Markdown代码块

在Markdown中,代码块以Tab键或4个空格开头,语法如下:

Markdown代码块

Markdown代码块

实例演示如下:

Markdown代码块

因为代码块使用Tab键或4个空格开头的效果不够直观,很多扩展语法(如GFM)提供了围栏代码块,并且支持语法高亮。

Markdown行内代码与代码块使用规范

除行内代码可以使用 ` 包裹以外,如果我们想转义或强调某些字符,也可以使用其进行包裹。

推荐:

Markdown行内代码与代码块使用规范

如果代码超过1行,请使用围栏代码块(扩展语法),并显式地声明语言,这样做便于阅读,并且可以显示语法高亮。

推荐:

Markdown行内代码与代码块使用规范

但如果我们编写的是简单的代码片段,使用4个空格缩进的代码块也许更清晰。

推荐:

Markdown行内代码与代码块使用规范

很多Shell命令都要粘贴到终端中去执行,因此最好避免在Shell命令中使用任何换行操作;可以在行尾使用一个\,这样既能避免命令换行,又能提高源码的可读性。

推荐:

Markdown行内代码与代码块使用规范

建议不要在没有输出内容的Shell命令前加。在命令没有输出内容的情况下,是没有必要的,因为内容全是命令,我们不会把命令和输出的内容混淆。

推荐:

Markdown行内代码与代码块使用规范

不推荐:

Markdown行内代码与代码块使用规范

建议在有输出内容的Shell命令前加上$,这样会比较容易区分命令和输出的内容。

赞(1)
未经允许不得转载:极客笔记 » Markdown 行内代码与代码块
分享到: 更多 (0)

评论 抢沙发

  • 昵称 (必填)
  • 邮箱 (必填)
  • 网址