變數和方法命名的最佳實踐

来源:https://www.cnblogs.com/phpyangbo/archive/2023/08/24/17654021.html
-Advertisement-
Play Games

在每個代碼範圍內使用足夠短和足夠長的名稱:例如迴圈計算器用一個字元就可以了,如i;條件和迴圈變數用一個單詞,方法名1-2個單詞,類名2-3個單詞,全局變數3-4個單片語成 為變數指定一些專門名稱,不要使用例如 "value", "equals", "data" 這樣的變數名 變數名要使用有意義的名稱 ...


  1. 在每個代碼範圍內使用足夠短和足夠長的名稱:例如迴圈計算器用一個字元就可以了,如i;條件和迴圈變數用一個單詞,方法名1-2個單詞,類名2-3個單詞,全局變數3-4個單片語成
  2. 為變數指定一些專門名稱,不要使用例如 "value", "equals", "data" 這樣的變數名
  3. 變數名要使用有意義的名稱,通過變數名能大概反映出其具體的用途
  4. 不要在變數名前加首碼,例如 o_, obj_, m_ 之類
  5. 服從公司命名規範,在命名時使用一致的做法,例如:txtUserName, lblUserName, cmbSchoolType, ... 除非是大大降低了可讀性
  6. 服從編程語言本身的規範,不要使用不連貫的小寫和大寫混合名稱,例如:userName, UserName, USER_NAME, m_userName, username, ...
    • 對 Java 而言:
      • 類名使用駝峰命名方式,如:VelocityResponseWriter
      • 包名小寫:net.oschina.beans.xxx
      • 變數名小寫開始的駝峰命名,例如:studentParentName
      • 常量名用全大寫:MAX_PARAMETER_COUNT = 100
      • 枚舉類名參考普通類名,枚舉變數使用全大寫
      • 不使用任何帶下劃線的命名方式(OSCHINA項目大量採用帶下劃線的變數,哈哈),除非是常量或者是枚舉值
  7. 不要在同一個類的不同上下文中重用相同的變數名
  8. 不要在一個方法內用同一個變數做不同的用途
  9. 不要使用非 ASCII 字元的變數,例如中文變數
  10. 不要使用太長的變數名,例如50個字元,這很難閱讀,而且可能超出一些編譯器的限制
  11. 確定並堅持使用固定的一種自然語言的命名方式,例如不要使用拼音和英文混合的命名方式
  12. 方法名要使用有意義的名稱,能通過方法名大概瞭解該方法的用途,而且方法名要以動詞開始,例如createPasswordHash
  13. 方法名要符合公司統一的規範,例如:getTxtUserName(), getLblUserName(), isStudentApproved()
  14. 方法名要遵循編程語言規範
  15. 方法的參數名要使用有意義的名稱 
  16. List定義的變數應該 List 作為尾碼結尾。

    Map定義的變數應該 Map 作為尾碼結尾。

    數組定義的變數應該 s 作為尾碼結尾。


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

-Advertisement-
Play Games
更多相關文章
  • # MurmurHash簡介 MurmurHash是一種非加密散列函數,名稱來自兩個基本操作,乘法(MU)和旋轉(R)。與加密散列函數不同,它不是專門設計為難以被對手逆轉,因此不適用於加密目的。在2018年迭代到了MurmurHash3版本,它可以生成32位或128位的哈希值。相較於其他哈希函數,M ...
  • 我們將介紹 Python 中的 gzip 解壓。我們還將介紹如何使用gzip解壓來解壓壓縮的內容。 ### Python中的Gzip解壓 在Python中為壓縮和解壓目的建立了許多庫,但我們將介紹Gzip 庫。它是一個流行的數據壓縮工具。 我們可以使用gzip ,通過對數據進行特殊格式的編碼來減少文 ...
  • 方法重載在Python中起著關鍵作用。方法有時接受零參數,有時接受一個或多個參數。 當我們以不同的方式調用同一個方法時,這就被稱為方法重載。Python不像其他語言那樣預設支持重載方法。 在Python中,兩個或多個方法不能有相同的名字,因為方法重載允許我們使同一個操作符具有不同的含義。讓我們詳細討 ...
  • # RUST 和 GO 如何管理它們的記憶體 ## Go 中的記憶體管理 Go 中的記憶體不會在緩存鍵被驅逐時立即釋放。 相反,垃圾收集器會經常運行以發現任何沒有引用的記憶體並釋放它。 換句話說,記憶體會一直掛起,直到垃圾收集器可以評估它是否真正不再使用,而不是在不再需要時立即釋放。 Go 必須付出的努力來找 ...
  • 安裝rabbitMQ的前提是安裝上erlang,所以從erlang安裝開始。 安裝erlang 1,先升級一下 $:sudo apt-get update 如果軟體源有問題 修改etc/apt/sources.list內為如下: # 國內源deb http://mirrors.aliyun.com/ ...
  • 給我一個CPU,給我一塊記憶體,我來執行一段代碼。 我要如何分配呢? ![](https://img2023.cnblogs.com/blog/3256961/202308/3256961-20230824111951962-1088592200.jpg) ` ` `new User();` 這裡有一 ...
  • 因為平時有多台設備要用,所以遠程桌面是我經常要使用的工具。 最近,正好看到一款不錯的遠程桌面軟體,馬上拿出來推薦給大家,如果有需要的可以看看。 ![](https://img2023.cnblogs.com/other/626506/202308/626506-20230824152205856-1 ...
  • 來源:blog.csdn.net/lvoelife/article/details/128092586 ## **1. 基本概念** 我們都使用過連接池,比如`C3P0,DBCP,hikari, Druid`,雖然HikariCP的速度稍快,但Druid能夠提供強大的監控和擴展功能,也是阿裡巴巴的開 ...
一周排行
    -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.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...