開源神器!答應我,別再用 abc 做變數名了好么!

  • 2019 年 11 月 11 日
  • 筆記

有一種痛,不是程式設計師可能不懂,但如果是程式設計師一定懂,那就是給變數或函數命名。

回想一下起名字這條路,剛開始學某個程式語言的時候,26 個字母還能解決問題,26 個不夠還能用字母與數字的組合?。但是,到了真正的項目中,別說老師不能容忍,老闆不能放過你,萬一哪天自己回頭看自己寫程式碼,可能也被自己難住了「什麼鬼,看不懂,表示的什麼」?

隨著項目越來越複雜,變數和函數數量越來越多,英語水平貌似也 hold 不住了。雖然每個程式語言都有各種命名規範,但是也不能解決所有的問題。每個程式設計師或多或少都在寫程式碼的時候為變數和函數命名苦惱過!

Phil Karlton 曾說「在 CS 領域中,有兩件事是非常難的,一個是快取失效,一個是命名。」

今天,營長要特別為大家介紹一個有點意想不到的工具——變數命名網站 Codelf。有人問了「這都行」?因為是真的有需求!

先介紹一下作者 Unbug Lee,2010 年畢業於某省電子科技大學,2011 至 2015 年間在網易任職,目前在 Hulu 北京的 AI 平台數據組任職軟體工程師,想必這些年也受了不少給變數和函數起名字的苦。

下面就開始說說這個神器怎麼用?

1、可以在 Codelf 網站上直接搜索,或安裝 Codelf 插件

直接在 Codelf 網站上搜索命名建議,可以直接訪問下面的地址:

https://unbug.github.io/codelf

也可以在自己用的編輯器里安裝插件,支援 VS Code、Atom、Sublime Text 和 Chrome。正好,營長電腦里有 VS Code,就試著安裝了一下。

大家也可以試一下吧!

2、主流程式語言目前都可以支援,比如 JS、Python、HTML、Java、PHP、C++、Go 等等。此外,輸入中文搜索英文也可以。幫你擺脫自己硬翻、辭彙量不足、糾結用哪個詞表達更貼切等囧境。不過,輸入中文進行搜索時會受到訪問量的限制,作者使用的是有道翻譯 API 免費套餐,一小時超過 1k 請求就會被封一小時,營長就先用「time」試了一下,大家在Github 項目地址里可以看到中文搜索的示例。

選擇 Python 語言得到的結果:

換成 Java 語言後的結果:

當你放到其中一個變數名上時,可以看到與此變數相關的更多資訊。比如,【Repo】鏈接到包含用這個名字命名變數的資源地址;【Codes】可以直接看到源碼;

在一段程式碼中快速定位,可以用快捷鍵:Tab 和 Shift+Tab。

除了英文,直接用中文進行搜索也是可以的,非常貼心。

3、其他實用功能

Codelf 還可以幫助開發者管理 Github 上的項目。我們看到一個喜歡的項目,第一個操作肯定是先點一下 Stars,時間久了,項目越來越多,快速檢索到當下想用的是一個非常 nice 的功能,正好 Codelf 也具備這個功能。大家可以把想收藏的項目的 username 輸入,然後進行分組或者直接用七個顏色的 Tag 簡潔標記一下就可以了。不用綁定自己的 Github 帳號。

傳送門: https://unbug.github.io/codelf/ https://github.com/unbug/codelf