2022-10-31

易讀程式之美學:提升程式碼可讀性的簡單法則 BY 貳團 吳芳儀

如何將讀者理解 code 所需的時間降到最短是提升程式碼易讀性的主要目標
(這個讀者可能是六個月後的自己)
書中的所提到的概念和邏輯是不限於特定語言的
作者以 Python、C++ 和 JavaScript 等程式語言舉了非常多例子
程式易讀性可能不影響本身的功能,但是對於後續測試、維護、debug、增建功能和文件撰寫都會有大大的幫助
-
自己讀完認為易讀性的改善主要可以分為下面 3 個面向:
🔅變數名稱命名
用明確精簡的詞彙來傳遞資訊
✏️這個我覺得難度在於知道的單字太少,沒辦法精準使用😵
🔅摘要性註解撰寫
包含功能目的、已做過的嘗試、待改地方、要注意的東西
✏️現在每個 function 開頭都會寫
“””
這個 function 要幹嘛
parameters
return
(包含變數名稱、型別和說明)
“””
🔅程式架構
邊寫邊想像自己會如何向同事解釋
試著用口語來表達,並且怎麼說就怎麼寫
將不相關的子問題抽離並獨立解決
熟悉標準函式庫,讓適合的工具來幫助自己
-
最後一章節以兩個 program 作為範例,從沒那麼好的程式碼出發,一步一步點出如何修改為更易讀更有效率的寫法
推薦大家有興趣可以看書裡舉的各種例子,會更有感
看完之後會試著在往後撰寫程式碼時去實踐
希望可以讓別人接手自己的 program 時不要咒罵我😳