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