我以後寫程式一定會加註解

I-will-make-comment-before-coding
我以後寫程式一定會加註解

Well…會有這篇啟發自辛普森的惡搞並不是因為我寫程式不加註解
相反地,寫程式加註解對我有如家常便飯…

但由於今年工作單位導入 CMMI
不僅文件撰寫要嚴謹,就連程式開發也有嚴苛的要求
功能達成只是基本需求,程式撰寫者更要維護整體格式使其一致
比方說變數命名、函數宣告等,其中註解的部分讓我吃了點苦頭…

以往個人習慣以單行註解居多
但依照工作單位的程式撰寫規範,還必須在每個函數宣告及實作時都加上註解
因此昨天整個下午的工作居然就是 “加註解”,導致第一次我在工作場合感到想睡

整個專案開發下來,例外處理的程式碼佔了近 1/3
而新加註解可能又與全部程式碼等量
故我戲稱,CMMI 程式撰寫規範的另一個功能,就是讓程式碼看起來十分壯觀…~!@#$%

最後追加一張英文版的,看起來原汁原味

I-will-make-comment-before-coding_English
I will add comments when coding

Leave a Reply

Your email address will not be published.