看板
[ Soft_Job ]
討論串[討論] 要不要寫註解
共 9 篇文章
內容預覽:
寫啊 當然要寫. 但是不是拿來把程式邏輯用中文或英文重寫一次. 而是要把這段程式的緣由、目的、特例交代清楚. 比如. // 此功能因某某某要求故加上XXX 2019.10.26. 如果能把ticket單號列進來更好. 這樣一看這段註解就能了解當時作業的來龍去脈. 以後老闆靠邀為什麼要寫xxx功能時.
(還有11個字)
內容預覽:
講到這個我就想浮出來,. 寫程式寫了也快20年了吧?. 我真的不知道什麼叫做命名命的好不需要寫註解,. 會覺得自己命名很棒而不需要寫註解,. 是很自大的想法,. 更多是用來偷懶當不想寫註解的理由,. 實在搞不懂為什麼有人連花個5分鐘寫註解都不願意,. 結果他放假,別人看不懂他的code,只能call
(還有428個字)
內容預覽:
這個問題討論很多次了. 先講一下寫註解最可能的缺點好了. 第一 程式碼與註解不同步. 也就是當程式碼更新的時候. 註解沒有更新. 第二 多了許多雜訊. 如果註解沒寫好的話. 反而是個干擾閱讀的東西. 那不寫註解又有什麼缺點. 第一 對於功能沒有說明都需要由程式碼來了解. 所以可能必須花更長的時間來理
(還有218個字)
內容預覽:
聽過說法是. 1.寫註解是浪費時間，命名命的好不需要寫. 2.寫註解方便維護，而且讀中文一定比讀英文快. 自己是常常忽略註解，. 不過有空還是會補上，. 因為程式都只有我在弄，. 但是當大型系統過一陣子在拿出來改時，. 就知道不寫註解真的是省小時間花大時間，. 像是一堆函式傳幾個變數能跑出什麼，.
(還有68個字)