为什么要写注释如何不考虑自己写的情况下有人会拒绝注释吗日常中我们无时不刻都在感叹为什么没有注释?接手项目迟迟无法进入开发历史逻辑绕一圈才能半猜半疑确定是干什么得每一次重构都像走钢丝或许是在你大声喊出“这段代码是那个小可爱213写的”的时候同事默默发了一张你的提交记录…你终于下定决心要开始写注释。那么如何编写一个的注释呢首先我们需要知道怎么样的注释才是合格的。怎么样的注释才是合格的为什么要强调合格的注释呢借用网上的一个段子// 写这段代码的时候只有上帝和我知道它是干嘛的 // 现在只有上帝知道 // 神奇。勿动。而显示中的你的注释可能这样的//所以注释并不是越多越好越多的注释意味着你的代码逻辑并不清晰所以你依赖于注释去弥补你的代码逻辑混乱。所以合格的注释的第一步让你的代码逻辑清晰起来尽可能的依赖于代码的自描述。此后才是注释的战场给关键和难读懂的步骤和整体的功能进行解释说明。一个合格的注释需要让看到的人快速读懂并且意识到关键点。简单当我看见这句注释我能一眼看完清晰当我看见这句注释我能一眼看懂少当我看见这句注释我能继续看代码怎么开始一个注释写在结尾随着经历的项目越来越多逐渐从一开始的排斥开始意识到注释的重要性或许是
为什么要写注释如何不考虑自己写的情况下有人会拒绝注释吗日常中我们无时不刻都在感叹为什么没有注释?接手项目迟迟无法进入开发历史逻辑绕一圈才能半猜半疑确定是干什么得每一次重构都像走钢丝或许是在你大声喊出“这段代码是那个小可爱213写的”的时候同事默默发了一张你的提交记录…你终于下定决心要开始写注释。那么如何编写一个的注释呢首先我们需要知道怎么样的注释才是合格的。怎么样的注释才是合格的为什么要强调合格的注释呢借用网上的一个段子// 写这段代码的时候只有上帝和我知道它是干嘛的 // 现在只有上帝知道 // 神奇。勿动。而显示中的你的注释可能这样的//所以注释并不是越多越好越多的注释意味着你的代码逻辑并不清晰所以你依赖于注释去弥补你的代码逻辑混乱。所以合格的注释的第一步让你的代码逻辑清晰起来尽可能的依赖于代码的自描述。此后才是注释的战场给关键和难读懂的步骤和整体的功能进行解释说明。一个合格的注释需要让看到的人快速读懂并且意识到关键点。简单当我看见这句注释我能一眼看完清晰当我看见这句注释我能一眼看懂少当我看见这句注释我能继续看代码怎么开始一个注释写在结尾随着经历的项目越来越多逐渐从一开始的排斥开始意识到注释的重要性或许是
)
