看板
[ Soft_Job ]
討論串[請益] 寫註解到底是不是好習慣
共 24 篇文章
內容預覽:
這種討論clean code的東西. 各有各的說詞. 我個人也是偏向不註解. 但可能註解說明該module功能. 或是註解回傳的資料結構. 譬如. def get_city_population():. """. return [. {Taipei:[. {NanGan:1000},{WanHua:
(還有540個字)
內容預覽:
想額外小小分享個人覺得重要的概念 『 假如寫了註解一定要維護 』. 舉例. 前幾年老闆委託寫尾牙發錢活動程式. 中間改了幾次關於金錢的邏輯,特別獎金加碼,都沒有修改過註解. 今年老闆又要舉辦一次尾牙抽獎,這次沒有加碼,另外把程式交給一個新進員工來修改。. ```. void Main(){. /*.
(還有481個字)
內容預覽:
有一派看法是code寫的簡潔易讀,靠命名就能知道作用,. 寫太多註解沒好處. (因為註解也是需要維護的). 有一種例外. 當code充斥大量work around的時候,一定要加註解,避免後面維護的人踩地雷. 有些work around你不寫註解,真的沒人看得懂.. 建議是先看你的工作環境. 如果你
(還有37個字)