不然寫著寫著,當程式碼漸漸複雜,又加上多人共業,
再加上過了一段時間要來修改這些有問題的程式時,
沒有註解的程式碼,真的是要命喔。在多人協作的 VBA 專案中,缺乏註解可能導致維護困難。
更何況是大型的專案,沒有註解的程式碼, 不僅是改別人的,甚至是自己的程式碼,
真的是無從著手呀。
Excel VBA 跟其他程式一樣,都可以進行單行或多行註解。
以下就讓我們來試著在VBA中,進行單行註解試試看吧。
目錄
{tocify} $title={目錄}
註解
當我們在寫程式的時候,有時候為了幫助自己或團隊了解程式的內容
會希望在程式內容中可以註記,讓我們往後在維護程式碼的時候,
能夠更加地容易快速理解,往往都會在撰寫程式碼的時候加上註解。
會希望在程式內容中可以註記,讓我們往後在維護程式碼的時候,
能夠更加地容易快速理解,往往都會在撰寫程式碼的時候加上註解。
單行註解
Excel VBA與其他程式一樣,可以進行註解。
單行註解的方式,非常簡單,只要在該行程式碼的前方加上 ' 符號,
當游標離開該行時,該行程式碼就會變成綠色,
這時表示該行程式碼已被註解,
在之後執行程式時,會被略過,不會執行。
單行註解的方式,非常簡單,只要在該行程式碼的前方加上 ' 符號,
當游標離開該行時,該行程式碼就會變成綠色,
這時表示該行程式碼已被註解,
在之後執行程式時,會被略過,不會執行。
關於單行註解方式可參考以下連結影片
多行註解的方式
在Excel VBA中,若要使用多行註解的方式,
需要透過工具列,才可以進行一次多行的註解。
需要透過工具列,才可以進行一次多行的註解。
依據下列的方式進行設定,
檢視 > 工具列 > 編輯
依照上述的順序即可在上方的功能區出現以下工具列
檢視 > 工具列 > 編輯
依照上述的順序即可在上方的功能區出現以下工具列
這邊要注意,當程式備註解後,是不會被執行的
並且每一行的前方 都會出現 ' 符號,且程式碼會呈現綠色。
這代這代表程式已被註解,當程式執行時,會被略過不執行。
關於多行註解方式可參考以下連結影片
未進行註解可能引發的狀況
😫1. 程式碼難以維護
當你或其他人數週、數月甚至數年後再次開啟這段程式碼時,很可能無法理解每段邏輯在做什麼,尤其是條件判斷、迴圈邏輯或錯誤處理部分,甚至需要耗費大量的時間重新理解。也有可能當初開發程式的人已經離職,造成程式碼維護上的困難。
😫2. 降低團隊協作效率
在多人開發或接手他人專案時,缺乏註解的內容會造成理解與溝通成本上升,可能需要花費額外時間去 debug 和推測原始撰寫者的意圖,在團隊的協作上也有可能造成極大的困難。
😫3. 提高錯誤發生與遺漏風險
維護時若無註解輔助,開發者容易誤刪或錯改關鍵程式碼,因為無法分辨該段程式的用途與依賴關係。如果有人不小心誤刪了關鍵的程式碼,可能導致程式不穩定甚至是崩潰,抑或是造成程式的重大錯誤。
😫4. 減少程式碼的可重用性
當你想要將原本的邏輯重構或搬移到另一個模組時,你會發現,缺乏註解會導致你無法確認這段程式碼的輸入與輸出條件,造成重用困難,又或者需要再重新開發或撰寫新的程式或模組。
😫 5. 阻礙自學與知識傳承
若該 VBA 程式是用來教學內容或者是寫在公司內部文件中或開源,缺少註解會使初學者難以理解,降低學習與傳承效果。
因此在撰寫程式時 :
1. 為每個VBA模組、函式與重要邏輯段落加上簡短說明,敘述明確。
2. 註解時說明變數用途、以及條件判斷時的邏輯、輸入輸出格式。
3. 盡量避免重複註解或是避免寫「這是 if」類似的無效註解內容。
更進一步說,不管寫的是哪種程式語言,都一定要好好註解喔。