顯示具有 code 標籤的文章。 顯示所有文章
顯示具有 code 標籤的文章。 顯示所有文章

星期六, 8月 15, 2020

Visual Studio code snippets

 

一直都沒認真研究 vscode snippets 怎麼弄
今天去看了以後,發現蠻簡單的:

  • 啟用:選到 Preferences > Settings ,在上方的搜索框輸入 “editor.tabcompletion”,把 Tab Completion 選為 on 或 onlySnippets 就可以。在輸入 prefix (前置字串)後,按下 tab ,就會出現 snippets 讓你選擇。
  • 建立 snippets:
    • 手動建立:選到 Preferences > User snippets ,此時會要問你要編輯哪種類型檔案的 snippets,選好以後,會開啟一個 json 檔案,檔案裡面有註解說明,依照說明去編輯就可以了。編輯好,會立即生效。
    • 快速建立:安裝 Snippet Creator 這個 Extension (尋找 ryanolsonx.snippet-creator),安裝好以後,先選取你要建立 snippet 的文字,然後按下 `ctrl + shift + p` ,依照提示輸入 prefix, description 以後,就可以了。
  • 現成的 snippets:事實上,也有很多人把自己建立的 snippet 分享為 extension,供大家安裝。像 Python 就可以安裝 “Python snippets” (尋找 frhtylcn.pythonsnippets),或是 “Python extended” (尋找 tushortz.python-extended-snippets),或是 “Django” (尋找 bigonesystems.django),安裝好以後,就可以使用了。至於該 extension 有提供哪些 snippets,就得自己去挖 extension 的說明檔或是原始碼了,對,這個意思就是要稍微記一下有哪些 prefix (前置字串),否則就都沒用到,等於是白裝。

參考資料:

星期二, 10月 22, 2019

變數的命名

看這篇 The art of naming variables 的紀錄
變數命名的藝術,好吧,對非英語系國家來說,的確是有些難度。作者整理了一些慣例讓大家參考:
  1. Arrays :名詞字尾加上 s ,當複數。
  2. Boolean:變數用 is/has/can 開頭,例如 isOpen/hasWrite/canOpen,函數就用 check 開頭,例如 checkHasPermission()。
  3. Numbers:試著使用 min/max/total 來描述,例如 minBugs / maxPugs / totalFruits
  4. Functions:要有動詞跟名詞,例如 getUser() / calculateTotal() ;轉換的話,可以用 to,例如:toUppser() 。
我本來以為會有講 dict / list 的,但沒有,嗯,順手找了一下
  • List:可以考慮後綴就用 List,例如 namesList ,也有人把 list 擺在前面,例如 listOfNames
  • dict:有找,但沒有特定的慣例,參考 List 的命名作法應該是可以。然後有人這樣用 email_to_contact / ip_to_hostname
寫到這邊想起 Clean code 這本書有一章就是在講這個,直接看別人的讀書筆記/心得吧: