如何提高 Swift 程式碼的可讀性？

---

在本教程中，您將學習如何在 Swift 語言中提高程式碼的可讀性。

在編寫程式碼時，您可以遵循多種技巧。透過遵循這些方法，您將能夠為自己和其他開發人員編寫更易於理解的程式碼。

使用註釋

這是我們應該做的最重要的事情。在編寫程式碼時，我們經常編寫邏輯和計算。當我們開始時，我們的大腦中擁有所有內容，但是一個月後，肯定很難記住所有內容，尤其是在大型應用程式中。

程式碼通常在單行上進行註釋。因此，我們能夠更好地理解一段時間前編寫的程式碼或邏輯。在註釋中，不要僅僅描述一行程式碼的功能；新增解釋和見解。

一種不太常用的註釋型別是塊註釋。這些註釋通常用於將許可資訊和版權資訊放在檔案的頂部，但如果您需要編寫多行程式碼來解釋程式碼，它們也可能很有用（儘管一個好的經驗法則是，如果您需要用那麼多文字來解釋程式碼，它可能不夠易讀）。

要建立塊註釋，請以正斜槓、星號開頭，然後是您的程式碼。準備好結束註釋後，只需放置一個星號，然後是另一個正斜槓。

程式碼重用

程式碼重用是那些程式設計概念之一，它可能比最初看起來複雜得多。雖然很容易爭論說應該不惜一切代價避免程式碼重複，並且應該儘可能地重用和共享實現。

可重用程式碼的優勢

• 節省大量程式碼行

• 易於在一個地方進行更改

• 易於理解完整的功能

• 降低錯誤風險

• 維護編碼標準

有意義的命名

在 Swift 中，最有效的方法是根據物件在程式碼中扮演的角色來命名物件。例如，如果一個名為 apple 的變數型別是 Apple，但 apple 充當動物的食物，則可以將其命名為 food。

有時，我們可能會傾向於賦予一個應該專門化的物件許多職責。這可能使您的應用程式模組化程度降低，並且對於任何閱讀程式碼的人來說都會更加混亂。根據物件的功能對其進行命名可以幫助您記住只為物件賦予其負責的角色。

Apple 推薦的命名約定

屬性、變數和常量的名稱應讀作名詞。

布林方法和屬性的使用應讀作對接收者的斷言。

描述某物是什麼的協議應讀作名詞。

使用設計模式

在生產級應用程式中，開發人員使用設計模式以一種可以更改且更易讀的方式來構建程式碼。讓我們討論一些您可以在下一個 iOS 應用程式中使用的一些設計模式。

儘管這聽起來像是老生常談，但這確實是您編寫應用程式的基礎。假設您正在建造一棟房子，您的夢想之家。這棟房子有五層樓高，因此，如果您不打下堅實的基礎並遵循藍圖，它可能會傾倒。iOS 應用程式的基礎是您選擇的設計模式或模式。讓我們看看兩種最常用的模式。

一些流行的設計模式如下所示

• MVC − 模型-檢視-控制器或 MVC 設計模式是行業標準。它將程式碼的每個部分分成三個部分：模型、檢視和控制器。模型本質上是應用程式的資料。檢視僅負責視覺化資料。控制器從模型接收資料，然後將其傳送到向用戶顯示資料的檢視。

• MVVM − 使用標記語言或 GUI 程式碼，此架構可以實現使用者介面的開發與分離。MVVM 的完整形式是模型-檢視-檢視模型。MVVM 中的檢視模型是一個值轉換器，這意味著檢視模型負責以一種可以輕鬆管理和呈現物件的方式公開模型中的資料物件。

• 單例 − 單例是類的單個例項，它始終存在於記憶體中。

程式碼組織

您應該在正確的目錄結構中組織檔案。這使得查詢和跳轉到任何檔案變得容易，而無需搜尋它。根據應用程式中的模組建立正確的目錄。每個模組都可以擁有一個單獨的資料夾來組織與該模組相關的檔案。透過正確的程式碼組織，您可以輕鬆導航到檔案。

您還可以在檔案級別組織程式碼。例如，在一個檔案中，可能存在許多屬性和函式以及其他內容。因此，您可以使用檔案中的程式碼註釋對其進行組織。下面是一些如何在檔案中組織程式碼的示例 -

// TODO: <To-Do Item>: Mark any function or properties that need some work on it.
// FIXME: <Issue Title>: Mark your issues with this annotation to fix them later.
// MARK: <Section Title>: Mark your section with this annotation to categorize the code in a file.

結論

如您所見，使您的程式碼更具可讀性和組織性並不難。當您付出努力這樣做時，您將能夠輕鬆修改程式碼，並使您的程式碼更容易被其他人理解。