markdown里面編輯代碼


轉:http://c.biancheng.net/view/6623.html

---------------------------------------------------------------

對於編程語言的代碼,Markdown 支持代碼塊和行內代碼兩種形式。

Markdown 代碼塊

在 Markdown 中,代碼塊以 Tab 鍵或 4 個空格開頭,語法如下:

    def test_printf()
        pass

實例演示:

以Tab鍵開頭:

    def test_printf():
        pass

以4個空格開頭

    def test_printf():
        pass

因為我將 Tab 鍵定義為四個空格的寬度,所以兩者在視覺效果上是一樣的。

小提示:因為代碼塊使用 Tab 鍵或 4 個空格開頭的效果不夠直觀,很多擴展語法(如 GFM)提供了圍欄代碼塊,並且支持語法高亮,本文第三部分我們會講解。

以上代碼在 VS Code 下的展示效果:

Markdown代碼塊在VS Code下的展示效果

Markdown 行內代碼

在 Markdown 中,行內代碼引用使用反引號` `(位於 Tab 鍵的上方)包裹,語法如下:

`代碼`

實例演示:

使用 `cd ..` 命令切換到上一級目錄

使用 `mkdir 文件夾` 命令創建文件夾

以上代碼在 VS Code 下的展示效果:

Markdown行內代碼在VS Code下的展示效果

Markdown 語法高亮

單一顏色的代碼不容易閱讀,如果能讓關鍵字、標識符、函數、運算符等編程元素都標記上不同的顏色,那簡直太漂亮了,這就是語法高亮。

Markdown 語法高亮是一種擴展語法,它的格式如下:

```language
code
```

其中,language 表示使用的編程語言,code 表示輸入的代碼。

實例演示:

```c
#include <stdio.h>
int main()
{
    puts("C語言中文網");
    return 0;
}
```

在 VS Code 下的演示效果:

Markdown語法高亮在VS Code下的演示效果

使用規范

1) 除行內代碼可以使用` `包裹以外,如果我們想轉義或強調某些字符,也可以使用` `包裹。

推薦的寫法:

如果你想跑路可以執行`rm -f * /`命令。

如果你不想`跑路`請限制執行刪除命令的權限。

更多信息請查看`README.md`。


2) 如果代碼超過 1 行,請使用圍欄代碼塊(擴展語法),並顯式地聲明語言,這樣做便於閱讀,並且可以顯示語法高亮。

推薦的寫法:

```c
#include <stdio.h>
int main()
{
    puts("C語言中文網");
    return 0;
}
```


3) 但如果我們編寫的是簡單的代碼片段,使用 4 個空格縮進的代碼塊也許更清晰。

推薦的寫法:

進入虛擬環境:

    pipenv shell

安裝依賴:

    pipenv install

跳過lockfile:

    pipenv install --skip-lock


4) 很多 Shell 命令都要粘貼到終端中去執行,因此最好避免在 Shell 命令中使用任何換行操作;可以在行尾使用一個\,這樣既能避免命令換行,又能提高源碼的可讀性。

推薦的寫法:

```shell
jvs run  \
--test=tests/home/test_login.py::TestLogin::test_login_failed  \
--env=online \
--username="yanchangsheng" \
--password="123456" \
--url="http://c.biancheng.net/"
```


5) 建議不要在沒有輸出內容的 Shell 命令前加$。在命令沒有輸出內容的情況下,$是沒有必要的,因為內容全是命令,我們不會把命令和輸出的內容混淆。

推薦的寫法:

pipenv shell

不推薦的寫法:

$ pipenv shell


建議在有輸出內容的 Shell 命令前加上$,這樣會比較容易區分命令和輸出的內容。

推薦的寫法:

```shell
$ echo "test"
test
```

不推薦的寫法:

```shell
echo "test"
test
```


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM