在帖子中插入代码、命令、日志的正确方法

先说一下个人关于放日志、命令等内容推荐的原则:

  1. 能放纯文本就放纯文本,不要给文本截图(截图无法搜索文本、无法定位关键信息)。
  2. 实在无法放纯文本,或者有纯文本以外的内容(比如异常画面),则优先截图,不到万不得已不要拍屏(拍屏可能因为反光、摩尔纹等导致画面不清晰)

这个论坛使用的是 Discourse 系统,该系统支持 Markdown 语法。为了获得更好的阅读体验,并避免代码、命令、日志中的特殊符号被错误地渲染成其他样式,强烈推荐大家将这些内容 放在代码块中

1 单独成段

如果希望代码、命令、日志作为单独的段落,请这样输入:

```语言名称(如果不希望使用代码高亮则写 text)
具体内容
```
示例1:命令

比如:

```bash
echo "Hello world!" > test.txt
```

显示效果是:

echo "Hello world!" > test.txt
示例2:Rust语言代码

比如:

```rust
fn main() {
    println!("Hello World!");
}
```

显示效果是:

fn main() {
    println!("Hello World!");
}

2 放在行内

如果想在某一行内显示纯文本内容,则可这样操作:

上文 `代码` 下文
示例

比如:

名为 `$HOME` 的变量记载了您的主文件夹的位置。

效果:

名为 $HOME 的变量记载了您的主文件夹的位置。

可以看到 “$HOME” 是使用等宽字体渲染的。

3 超大段代码

对于内容非常多的代码,建议大家使用公共粘贴板服务。比如下面这个:

注意公共粘贴板一般有保存时限。如需长期保存,可以考虑使用网盘等。

附 1:会被 Discourse 系统进行渲染的特殊符号:

* @ $ `(反引号) 
1 个赞