养成写注释的好习惯
注释是很重要的,特别在一些大公司里,对于注释的要求特别高,看一个程序员的水平高低,一般看他的注释就能看出来,所以平常养成写注释的好习惯对应程序员来说是很重要的。一般注释和源代码的比例是1:1,甚至1:2或者1:3。
自己就有这种体会。别人发来代码要我修改,一看源代码那叫惨不忍睹,密密麻麻的一片,不见一个中文(当然写英文注释还是可以理解的)。修改起来这叫我痛不欲生啊!自己要里弄懂每个变量,每个语句是什么含义,这个代码块是什么作用,如此等等。反正我是受不了这种摧残,还不如叫我自己实现这个功能。所以写好代码的注释不仅是你受用,别人也会受益匪浅。
优美的代码是必须要有注释的。阅读注释详细、稳妥的代码是种享受,或许只有程序员才能体会其中的乐趣吧。
平时注意这个习惯,写好注释。一是因为别的程序员会使用你的程序,增加程序的可读性。别人使用起来方便,如果没有注释,别的程序员还不如自己重新写,这样效率或许会快些。二是自己以后也需要阅读,人的记忆不可能永远那么好,总有忘记的时候。所以写好注释可以让自己快速地明白当初自己写代码的含义,这样会事半功倍。
从现在开始,给代码写上注释吧,让自己走得更稳,更远。
CSDN博客原文:http://blog.csdn.net/wentasy/article/details/7623773