【當個乾淨的程式猿】什麼是 Clean Code?

前言

在雨後春筍的 AI 時代,常聽許多人說軟體工程師要被取代,而有些工程師們也感受到即將失業的危機感。在這樣的環境下,我也在思考著,AI 的高效產出,怎樣的軟體工程師會繼續留下來,而新加入的工程師又需要具備怎樣的能力?

開始吧~

原始的程式猿,總是把功能寫得髒兮兮的,有些程式猿時常會把會動當作自豪的事情。要成為一個愛乾淨的程式猿,我們可以遵守一些規則,也是前輩們傳承下來的寶貴知識,我們可以先從幾個方面來了解:

  1. 名稱
  2. 註釋
  3. 格式
  4. 函式
  5. 例外處理
  6. 類別和資料結構

名稱

我們每個人都有名字,在華人文化裡,名字的第一個字都會是自己的姓,而遵行這樣的規則,就是我們中文取名的命名規則。那為何寫程式也要有命名規則,因為它能讓我們更好理解程式在做的事情,不管是變數、函式、類別等等,都要有好的名稱,這也是成為乾淨程式猿的第一步。

註釋

註釋可以讓我們理解和回顧程式碼,不論是協作上還是日後接手的人員,都能更快速找到要找尋的功能或 Debug。不過這邊要注意的是,註釋不是寫的越長越好,這樣反而使程式碼變得更加髒亂,所以適當的添加是需要特別注意的地方。

格式

好的格式很重要,就像我們書寫作文,也會有規定的格式。在寫程式中,我們可以善用 IDE 提供的格式化功能,或者可以找尋一些插件協助,如果是手動調整格式的話,要多多使用 Tab 鍵,這個鍵是程式猿的好朋友。

函式

函式裡參數的數量很重要,一般來說要放入超過三個參數的函式就要調整。這就好比我們櫃子裡,放入過多的物件,一個收納空間會被塞爆,通常都是缺乏分類,而在程式裡我們可以使用組合來解決這樣的問題。在有些時候我們也可以使用具名參數,增加程式碼的可讀性。

例外處理

在寫一些功能時,我們會需要例外處理,像是 IO 端的控制、資源控管以前驗證資料等等。而做這件事情是為了使程式更加穩定,避免程式崩潰,和方便 Debug.

類別和資料結構

一個類別要做的事情必須明確,如果過於模糊,那會使當前類別的職責過於龐大,而職責過於龐大,在程式碼的擴充跟維護,都會變得非常困難。再來,在程式碼中,加入過多的巢狀結構也會使程式碼,變得非常混亂。

總結

當我們有紀律的去遵守以上規範時,我們會變成一個人見人愛的程式猿,想必大家都喜歡乾乾淨淨。作者也會與大家一同學習,成為一名愛乾淨的程式猿,共勉之。

分享你的喜愛