我对程序员写注释的一点看法

本文讨论了程序员是否应该写注释,强调了代码可读性和重要性决定注释需求。好的代码可能少些注释,而差的代码则需要更多注释。关键在于注释的质量而非数量,应避免形式主义。

        程序员写不写注释,不能一概而论。

        你代码可读性好,非常标准,别人看起来很舒服,很容易理解读懂,那当然可以不用写注释,更不用每行都写注释,代码本身就是注释,或者代码就是文档。此时,写注释显得有些多余,高手点到为止,无需啰嗦。但是达到这种境界的毕竟非常少,你需要好好评估下你是否真的不需要写注释了。

        但是话说回来,无论您的代码多么优秀,在非常重要且逻辑复杂的地方,还是要注释的,好记性不如烂笔头,这个注释以后对自己对别人都是有很大的帮助的。还有,这个注释,不能是形式上的注释,而应该是实质上的。比如告诉别人那是一个循环,这就是形式上的注释,属于废话了,没有半点作用,但凡是个程序员一看就知道。此时,正确的注释应该是,这段循环起到什么作用,为什么要这么做,没有更好的方案了吗?

        大部分程序员不爱写注释,不要告诉我什么时间仓促,这都是借口,本质上还是懒,既然你希望别人给你写注释,为什么你不能给别人写注释呢?多看看优秀框架的源码,大家会发现老外的代码有个很明显的特点,注释比代码本身要多的多,难道人家时间很充裕?再者,你是在为公司写代码,为团队写代码,为客户写代码的话,而不是你自己一个人代码,你更应该有责任把代码写好注释,甭管您的代码水平如何,如果您写的代码可读性没那么好,没达到那种境界的话。写好注释就是一个负责任的态度,是您的职责所在。而不是逍遥任性随心所欲的写代码。

综上所述,

1,写注释是一种职责,是一种责任,是一种态度。与能力,时间无关。

2,代码写的好,可读性强,可以适当的少些注释;

3,代码写的不好,可读性差,那就更没任何理由不写注释了。

4,写注释关键是要精简,达意,避免形式主义。

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

小小哭包

创作不易,给作者加个鸡腿吧

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值