作者yamakazi (大安吴彦祖)
看板Soft_Job
标题Re: [讨论] 要不要写注解
时间Sat Oct 26 20:35:01 2019
我们公司反而是比较流行不写注解
但有另外的对应方法
有需求或有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
我觉得这也算一个不错的方法
-----
Sent from JPTT on my iPhone
--
※ 发信站: 批踢踢实业坊(ptt.cc), 来自: 180.217.140.111 (台湾)
※ 文章网址: https://webptt.com/cn.aspx?n=bbs/Soft_Job/M.1572093306.A.444.html
※ 编辑: yamakazi (180.217.140.111 台湾), 10/26/2019 20:37:26
1F:→ flysonics: 喔喔 这主意不错 10/29 13:09