如何選擇好的變數名!

来源:https://www.cnblogs.com/Teclado/archive/2020/04/22/12752606.html
-Advertisement-
Play Games

想要提升你的代碼質量,那必不可少的變數名的合理選擇,系統整理歸納知識清單,快速梳理掌握訣竅,變數名的正確的形式! ...


  一個好的變數名能夠完全的,準確的表達所代表的事物。

  能否命名出好的變數名對於一個程式的可讀性和維護性而言至關重要。

  變數的命名如此重要,但對於很多初學者來說並不重視,帶有一些隨意的心態命名變數,如果養成不正確的習慣會讓之後的學習變得更艱難。

  本次將整理一些有用的變數命名方法提供給大家參考:

 

基本技巧

 一. 變數名應儘量用文字表述清楚,要求沒有歧義並且完整,可以通過名字快速瞭解到事物的本質。而且名字不宜過長或過短。

x,x1,x2;   //是壞名字,無法理解變數表示的含義
date;      //是壞名字,這裡的日期的包括所有日期,意義並不准確
todaydate; //表示當前日期,可以快速明白含義

  二. 約束變數名的長度,名字太短會增加理解難度或者語義混亂,太長會讓代碼行變得冗餘。所以適當約束長度會讓程式解讀和維護更高效,畢竟變數名的好壞對別人解讀代碼的影響更大。

      研究表明,變數名長度在10-16個字元時,調試程式花費的氣力是最小的,

numberOfPeopleOnTheOlympicTeam;    //過長

n,bp,nst,max;                      //過短

teamPointsMax,pointsRecord;       //正好

  三. 計算限定詞後置,變數命名時會遇到表示計算結果的變數:總額, 平均值, 最大值等,那麼應該把 Total , Sum , Max , Min 等放在要修飾的名字後面,並且形成這樣的習慣,避免程式中出現  totalRevenue  和  revenueTotal  產生的歧義。

revenueTotal     ,     espenseTotal     ,    revenueAverage   ,    expenceAverage 

totalRevenue     ,     totalEspense     ,    averageRevenue   ,    averageExpense   //很容易看出上一行更符合編碼的習慣

  四. 準確的使用對仗詞,命名時遵守對仗詞的命名規則有助於保持一致性,從而提高可讀性。下麵列出常用的一些對仗詞:

open/close        begin/end      show/hide      create/destroy    
lock/unlock       first/last     min/max        start/stop     
get/put           uo/down        old/new        source/target

  五. 謹記典型的布爾變數名,,給布爾變數賦予隱含“真/假”含義的名字。例如 done error , found  ,success 等

  六. 區別變數名和子程式名字,變數名以小寫字母開頭,子程式用大寫字母開頭。例如 variableName 對 RoutineName 。

  七. 區別類與對象的名字,下麵有幾種標準方案:

       *  通過大寫字母開頭區分類型和變數 ------ Widget 和 widget , LongerWidget 和 longerWidget 。

       *  通過加“t-”首碼區分類型和變數 ------- t-Widget 和 Widget , t-LongerWidget   和   LongerWidget 。

       *  通過給變數加“a”首碼區別類型和變數------- Widget 和 aWidget , LongerWidget 和 aLongerWidget 。

       *  通過對變數採用更明確的名字區分類型和變數------- Widget 和 employeeWidget , LongerWidget 和 fullEmployeeWidget 。

  八. 標識全局變數,可在全局變數名之前加“g-”,那麼當讀到這個變數就會很清楚知道這是個全局變數,例如 g-RuningTotal , g-ColorPointer 。

  九. 標識成員變數,要求能夠名字識別出變數是類的數據成員,可在成員名字前加“m-”,;例如 m-ClassVariable , m-Velocity 。

  十. 標識具名常量,通常在常量名前加“c-”,而在C中則是全為大寫,例如 c-ReceaMax , RECESMAX 

  十一. 利用格式化命名提高可讀性,常用是以下倆字方法:

      *  利用大小寫來分隔單詞,例如 PointerTotal InvalidFirst 。

      *  利用分隔符來分隔單詞,例如 gymnastics-pointertotal pointer-total 。

      這倆種方法各有好處  ,但是一定不要混用,那樣會使代碼難以閱讀。

  十二. 給出一些關於變數名縮寫的技巧,能夠有效的縮短變數名,提高代碼質量

      *  使用標準的縮寫(字典中或者人們熟悉的常見縮寫)

      *  去掉虛詞 and ,or ,the 等

      *  去除無用的尾碼, ing  ,ed  等

      *  保留每個音節最引人註意的發音

      *  統一將每個單詞的第一,第二或者第三個(選擇最合適的一個)字母後截斷

  十三. 最後給一些應該避免發生的命名規格

      *  避免使用令人誤解的名字和縮寫

      *  避免使用具有相似含義的名字

      *  避免在名字中使用數字

      *  避免在名字中拼錯單詞

      *  不要使用與變數意義完全無關的名字

 

  記住,名字對於代碼讀者的意義要比作者更重要!

                                                                                                                                                                                                                                                                        --參考資料《代碼大全》第二版


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 網上關於執行上下文的文章有很多,關於什麼是執行上下文,很多文章說得很清晰。 我說一下自己的理解。 執行上下文包含三個東西: 1. VO 2. this 3. [[scope]] 為什麼包含這三個東西呢?首先我們要明白,什麼叫做執行上下文。 執行上下文,又叫做執行環境。那麼,什麼是環境呢? 維基百科是 ...
  • 1.對數組打亂順序 <!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title ...
  • 一.帶隱藏文本信息的圖片 通過RGB 分量值的小量變動,不影響對圖片的識別。因此,我們可以在圖片加入文字信息。 最終達到如下效果: 首先,在該組件中加入img用於顯示圖片 1 <canvas ref="canvas" v-show="0"></canvas> 2 <img :src="imageUr ...
  • 隨著近幾年前端和後端的界限融合,各個企業對於這個崗位的要求也不僅僅只是局限於切切圖,寫寫JS,掌握前端框架就行了。那麼如何成長為高級web前端工程師呢?首要任務就是提升編程核心內功,建立健全演算法知識體系。下麵我們來看看如何掌握數據結構與演算法知識,完成高級web前端工程師的成功轉變 1、為什麼要學數據 ...
  • 做完頁面後,用手機打開看後發現首頁背景圖變小了,留有空白,就是試著使用了媒體查詢@media 寬度小於768px的使用手機版背景圖,寬度大於768px的使用PC版背景圖。 1 /*背景圖片*/ 2 3 @media screen and (max-width: 768px) { 4 .body_im ...
  • 基本定義 單例模式就是確保某一個類只有一個實例,並且提供一個全局訪問點。單例模式有如下幾個特點: 它只有一個實例。 它必須要自行實例化。 它必須自行向整個系統提供訪問點。 代碼實現 餓漢式 直接初始化靜態變數。這樣就保證了線程安全。 public class Singleton { private ...
  • 1 簡介 是高性能的 資料庫,經常作為緩存流行於各大互聯網架構中。本文將介紹如何在 中整合 ,使用 的方式操作。 代碼結構如下: 2 整合過程 2.1 安裝Redis資料庫 為了節省時間,就直接通過 來安裝了,可以參考文章: "Docker安裝Redis並介紹漂亮的可視化客戶端進行操作" ,可以快速 ...
  • 一級標題 二級標題 三級標題 四級標題 五級標題 六級標題 粗體 斜體 斜體加粗 ~~刪除線~~ 引用 分割線 圖片 超鏈接 "百度" 列表 1. A 2. B 3. C A B C 表格 name|sex|age | | 月魂|男|21 xx|xx|xx 代碼 以下為本文的 Markdown 代碼 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...