使用者程式碼片段 code snippet

Visual Studio Code
  1. 1. 簡單示範
  2. 2. 使用 snippet 寫 RestFul API 常用 function
  3. 3. 參考資料

最近在試著做一個 nodejs 後端的 RestFul API，所以像是處理 res, req 的 function 很常用到，為了保持寫法一致，還有就是加速開發速度，只要使用一些關鍵字就可以快速寫玩一個 function。

簡單示範

在 VS Code 可以自定義程式碼片段，像是輸入關鍵字 ‘log’，就跑出自動完成的選項

自動完成選擇

選擇到你要的選項後，就跑出更長的一段程式碼，像是這樣

自動完成結果

使用 snippet 寫 RestFul API 常用 function

我的 nodejs server api 程式碼長這樣子

nodejs restful api

可以看到 function 參數和 function 裡面的 try…catch… 樣子差不多，應該說重複的地方很多，所以就想要透過 snippets 自動完成，所以就在 typescript 的使用者片段加入以下的指令

1
2
3
4
5
6
7
8
9
10
11
12
13
14
...
"http res": {
    "prefix": "httpres",
    "body": [
        "async $1(req: Request, res: Response) {",
        "\ttry {",
        "\t\t$2",
        "\t} catch (error) {",
        "\t\tres.json(error);",
        "\t}",
        "}"
    ],
    "description": "http request and response function"
}

我只要輸入 httpres 就可以看到自動完成，選擇後的結果也可以隨時修改，儲存後就立馬生肖，非常好用。

http snippet select

http snippet result

參考資料

Creating your own snippets

Markdown and VS Code

Nodejs + Express + Typescript + Decorator

snippet