跳到主要內容

程序員的命名素養

引言


今天來聊聊命名相關內容。


在日常工作中,項目、類、方法、表等等等等,都需要我們起名來標識區分。好的名字讓人賞心悅目,不好的名字讓人看的想吐。


最近工作有幸寫了node、前端、php、sql、scala,也見識了公司各位前輩們的命名功底。其中不乏abc命名、拼音命名、蹩腳英文命名,更有不少從別的地方粘過來連名都不改的操作。


命名沒有對錯,只是規範一點,可以提高可讀性、可維護性。


命名原則


拼寫正確


拼寫正確是可讀的基礎。


play shiftplay shit自己體會一下


清新明了,見名知意


根據要表達的內容命名,一針見血。


getNameById 根據id獲取名稱
ClassLoader 類加載器
MYSQL_USERNAME mysql用戶名

如上幾個例子,我們一眼就知道要表達什麼,可讀性高。


使用英文字母命名


在編程中,英文還是較為主流的,最好使用單詞來命名,再不濟也是用拼音來命名。


不論是拼音或單詞,清晰表意是首要。


保持一致


在一個項目中,應該使用統一的規範來命名。


無規矩不成方圓。


合理使用動詞名詞


類名、變量名通常應使用名詞。如ClassLoaderuserId


對於方法名、函數名,應包含動詞。如handleClickgenerateUniqueId


命名方法


常見的命名方法有駝峰命名法、匈牙利命名法、帕斯卡命名法、中/下劃線命名法


駝峰命名法Camel-Case


駝峰命名法,又叫小駝峰命名法,如名稱所表達的意思,指混合使用大小寫字母老表示名字。


userIdgetCompanyNameById


應用很廣泛。


匈牙利命名法


基本原則是:變量名=屬性+類型+對象描述。通過名稱可以直觀的了解他的所屬、類型等信息。


是早期的命名方式,早期IDE沒有很智能的時候,這種命名是很有必要的。


iNum,表示int類型的num


現在依舊很少有人用了。


帕斯卡命名法


又叫大駝峰命名法,就是把駝峰命名的首字母大寫了。


ClassLoader


中/下劃線命名法


單詞全部小寫,單詞和單詞間用中劃線或下劃線分割。


user_idpython-flask-demo


下劃線命名在數據庫中較為常見。


常量命名法


這個不是官方的方法,但是常量一般是由固定規範的。


格式:所有單詞的所有字母都是大寫,單詞之間用下戶線連接。


APOLLO_NAMESPAC


總結


好的命名習慣是每個程序員必備的基本素養。


寫代碼時,好的命名會讓思路更加清洗,代碼寫的更加絲滑。


代碼就是程序員的形象,從命名的細節開始,讓自己更帥一些。



個人公眾號:碼農峰,定時推送行業資訊,持續發布原創技術文章,歡迎大家關注。

本站聲明:網站內容來源於博客園,如有侵權,請聯繫我們,我們將及時處理

【其他文章推薦】



網頁設計一頭霧水該從何著手呢? 台北網頁設計公司幫您輕鬆架站!



網頁設計公司推薦不同的風格,搶佔消費者視覺第一線



※Google地圖已可更新顯示潭子電動車充電站設置地點!!



※廣告預算用在刀口上,台北網頁設計公司幫您達到更多曝光效益



※別再煩惱如何寫文案,掌握八大原則!



網頁設計最專業,超強功能平台可客製化



Orignal From: 程序員的命名素養

留言

這個網誌中的熱門文章

.NET Core前後端分離快速開發框架(Core.3.0+AntdVue)

.NET Core前後端分離快速開發框架(Core.3.0+AntdVue) 目錄 引言 時間真快,轉眼今年又要過去了。回想今年,依次開源發布了 Colder.Fx.Net.AdminLTE(254Star) 、 Colder.Fx.Core.AdminLTE(335Star) 、 DotNettySocket(82Star) 、 IdHelper(47Star) ,這些框架及組件都是本着以實際出發,實事求是的態度,力求提高開發效率(我自己都是第一個使用者),目前來看反響不錯。但是隨着前端和後端技術的不斷變革,尤其是前端,目前大環境已經是前後端完全分離為主的開發模式,在這樣的大環境和必然趨勢之下,傳統的MVC就顯得有些落伍了。在這樣的背景下,一款前後端分離的.NET開發框架就顯得尤為必要,由此便定了框架的升級目標: 前後端分離 。 首先後端技術的選擇,從目前的數據來看,.NET Core的發展遠遠快於.NET Framework,最簡單的分析就是Colder.Fx.Core.AdminLTE發布比Colder.Fx.Net.AdminLTE晚,但是星星卻後來居上而且比前者多30%,並且這個差距在不斷擴大,由點及面的分析可以看出我們廣大.NET開發人員學習的熱情和积極向上的態度,並不是某些人所認為的那麼不堪( 走自己的路,讓別人說去吧 )。大環境上微軟积極擁抱開源,大力發展.NET Core, 可以說前途一片光明。因此後端決定採用 .NET Core3.0 ,不再浪費精力去支持.NET Framework。 然後是前端技術選擇,首選是三大js框架選擇,也是從實際出發,Vue相對其它而言更加容易上手,並且功能也毫不遜色,深得各種大小公司喜歡,如果偏要說缺點的話,那就是對TS支持不行,但是即將發布Vue3.0肯定會改變這一缺陷。選擇了Vue之後,然後就是UI框架的選擇了,這裏的選擇更多了,我選擇了Ant Design Vue,理由便是簡潔方便,十分符合我的設計理念。 技術選型完畢之後便...