你喜欢注释丰富, Commit Message 详尽,还是反之?

查看 194|回复 25
clemente   
写 changlog 就行
OneLiteCore   
大多数时候 Commit Message 基本没啥人看,代码的话也只有重构或者出问题的时候才去看,此时代码内的注释作用更大些,但也不是说注释越多越好。个人感觉代码内的注释只要解释清楚为什么这么做以及这么做的用处是啥,那就算足够了。
THESDZ   
不是注释本身多少,而是代码本身的就该自解释
而自解释也有讲究,如:方法名完备,参数名正确,主方法行数少,但逻辑清晰,避免 if/else (用适配器或者 if return )
注释只做补充,比如明明可以用 bitmap 来压缩内存,但出于 xxx 考虑不压缩等,类似这种的。
IMengXin   
注释丰富,Commit Message 简洁
注释是为了让以后的自己能看懂,Commit Message 是为了以后来查哪个功能是哪天更新的
kristofer   
不管注释,那是我的 AI 该想的问题。
ximaoyang   
引用自 martin 的重构
1. 注释是一种信号,不是奖励
当你发现自己需要写注释才能让一段代码被理解时,Fowler 认为第一反应不该是"好,那就写清楚点",而应该是问:为什么这段代码不能自己说清楚? 通常答案是——需要重构了。
2. "需要注释"是 Extract Function 的触发器
书里明确把这个当作重构信号:如果你想写注释来解释一个代码块在做什么,那就把这个代码块提炼成一个函数,函数名就是那句注释。
您需要登录后才可以回帖 登录 | 立即注册

返回顶部