Re: [討論] 要不要寫註解

作者: yamakazi (大安吳彥祖)   2019-10-26 20:35:01
我們公司反而是比較流行不寫註解
但有另外的對應方法
有需求或有bug一律開ticket
討論盡量在ticket上 而不用信件來往
有什麼附件比如log也可以加在JIRA上
還可以在confluence上畫好UML圖
例如class diagram, sequence diagram
上code後 perforce上寫上ticket number
JIRA上把root cause/solution/concept/ticket number寫好
Perforce有 time lapse view
如果忘了哪段code是幹嘛的 可以回頭查ticket number
再上JIRA看當初的ticket寫了什麼
反而沒什麼人在code本身commet這個class在幹什麼
或input output在幹嘛
跟linux 源碼的code commet比較起來 我們公司的code commet少很多 大概只有10%左右
但完全不會影響我日常工作
而且也不用額外花時間維護commet
我覺得這也算一個不錯的方法
作者: flysonics (飛音)   2019-10-29 13:09:00
喔喔 這主意不錯

Links booklink

Contact Us: admin [ a t ] ucptt.com