為擴充套件現有物件的 Swift 檔案命名,最佳實踐是什麼?


並沒有一個單一的“最佳”實踐來命名擴充套件現有物件的 Swift 檔案,但以下是一些常用的約定:

物件字首後跟功能

  • String+Utilities.swift − 為 String 類新增實用程式函式

  • Array+Sorting.swift − 為 Array 類新增排序函式

  • UIColor+Extensions.swift − 為 UIColor 類新增顏色相關的函式

功能字首後跟物件

  • CustomView+Animation.swift − 為名為 CustomView 的自定義檢視類新增動畫功能

  • JSONEncoder+CustomEncoding.swift − 為 JSONEncoder 類新增自定義編碼和解碼功能

  • UICollectionViewLayout+Extensions.swift − 為 UICollectionViewLayout 類添加布局相關的函式

描述性命名

  • Date+ISO8601String.swift − 為 Date 類新增處理 ISO 8601 格式字串的函式

  • UIImage+Manipulation.swift − 為 UIImage 類新增影像處理函式

  • URLSession+Retry.swift − 為 URLSession 類新增使用重試失敗網路請求的功能

以下是一些在命名擴充套件現有物件的 Swift 檔案時需要考慮的其他要點:

  • 精確且具有描述性 − 為檔案賦予一個準確反映其目標的名稱。描述性名稱有助於其他編寫者理解檔案的作用,而無需閱讀程式碼。

  • 保持統一的命名約定 − 選擇一種模式並在整個軟體中一致地使用它。這使得程式設計師更容易找到相關的檔案,並確保軟體井井有條且易於理解。

  • 避免使用縮寫 − 雖然它們看起來很方便,但縮寫可能會令人困惑且難以理解。使用完整的單詞來準確地解釋新功能。

  • 選擇簡短且簡單的名稱 − 檔名應該易於編寫、閱讀和記住。避免名稱過長或難以發音。

  • 用“+”號分隔專案和副檔名 − 為擴充套件現有物件的命名檔案時,“加號”區分物件名稱和副檔名。例如 String+Utilities.swift。

  • 為了避免命名衝突,如果您正在擴充套件一個已經具有相同名稱副檔名的物件,請選擇一個替代名稱。

結論

透過遵循良好且正確的命名約定,您可以正確地組織檔案。這將幫助您輕鬆地處理和修改擴充套件。當我們處理包含許多擴充套件檔案的大型專案時,命名約定非常重要。

更新於:2023年5月4日

801 次瀏覽

啟動您的 職業生涯

透過完成課程獲得認證

開始
廣告