同学,请你一定要写注释呀!

2019-06-21  本文已影响0人  ___Jing___
/**
 *   ┏┓   ┏┓
 * ┏┛┻━━━┛┻┓
 * ┃       ┃
 * ┃   ━   ┃
 * ┃ ┳┛ ┗┳ ┃
 * ┃       ┃
 * ┃   ┻   ┃
 * ┃       ┃
 * ┗━┓   ┏━┛
 *    ┃   ┃   
 *    ┃   ┃   
 *    ┃   ┗━━━┓
 *    ┃       ┣┓
 *    ┃       ┏┛
 *    ┗┓┓┏━┳┓┏┛
 *      ┃┫┫ ┃┫┫
 *      ┗┻┛ ┗┻┛
 *        神兽保佑 
 *        代码无BUG! 
 */

同学,无论你的语言表达能力有多差,都请你一定要写注释呀!

这两天在做代码迁移和重构,看着出自自己手下那毫无注释的代码,真想一巴掌拍死自己...

这还是自己写的代码呢,都有一种想M娘的冲动。

一开始自己也是写代码注释的,后来不写的原因也比较简单,一是感觉自己写的都是废话,流水账,很low,就不愿意写了;二是项目总是分到手的时候就比较赶时间,也就忽略这部分了。

其实现在想想,写一个注释,其实用不了多少时间的,起码比一段时间以后回来自己回忆和猜想的时间要短的多。

所以,就算自己的语言表达能力不好,也请写几句简单的注释,总有某一句会有帮助的。

不多说了,重构的部分,自己都在一行行的加注释,嗯!

上一篇下一篇

猜你喜欢

热点阅读