封面插圖
想出好的命名的確很難,但是有難的道理,因為好的命名只需要只用一兩個單詞表達你的根本意思。 -- Jeff Atwood
基于 Quora 網站上的一個關于“程序員職業生涯中最難的事”的討論帖,國外開發者 Phil Johnson 10 月中旬在 ITworld 發了一個投票,其結果有點讓他意外。
許多程序員認為編程時。
如何命名不僅是他們面臨的老大難問題,也是最重要的事情之一。
圖0
現實中母語是英文的開發者也會為命名苦惱,非英文母語的開發者更加為此苦惱。當你到Github上參與開源項目的時候,或者準備開源自己的作品,或者設計一個框架的時候,命名會是一個一直伴隨你的不大不小的問題。
我們平時會先查單詞,再比較近義詞,必要還要Google一下與我們期望表達的關聯性。但是還是不滿意。就一個變量名函數名隨著迭代的進行已經被我們改了多少次。有時候你巴不得身邊有個人直接告訴你。
如何不改變我們的平時的習慣就能日積月累的收獲變量命名的經驗呢?
回顧平時的習慣:
- 查單詞;
- 比較單詞語義;
- 比較代碼上下文;
- 確定命名。
只要把這幾個步驟縮短就能節省大量時間。CODELF 就是幫我們縮短這些步驟的一個變量名搜索工具。
CODELF 支持直接搜索中文(用的是searchcode和有道的API,所以支持中文),當你查中文的時候,Codelf 會直接查好單詞和單詞的近義詞給你,然后再搜索Github, Bitbucket, Google Code, Codeplex, Sourceforge, Fedora Project上的開源項目的源碼匹配出與這些詞匯相關的變量名和函數名。
1. 選擇開發語言
圖1
- 選擇開發語言進行搜索,結果會把同個源碼文件里匹配的變量名排在一起,如你選擇“C/C++”然后搜索“網絡連接”
2. 查看源碼倉庫
圖2
- 輸入待命名的變量,可以直接查看源碼來源的倉庫Repo;直接拷貝變量名等
3. 編輯器插件
圖3
- 常用編輯器Sublime Atom VScode 都有對應的插件
4. 一鍵搜索
圖4
-
添加Codelf 到Chrome搜索引擎中實現一鍵搜索,效果就是在Chrome 的地址欄:
- 輸入”E"
- 按 “Tab"鍵
- 輸入想搜索的關鍵字,比如”我想要“
- 按Enter回車就會立即打開Codelf并搜索出結果
關于更多技巧, 請閱讀原文。