写在前面:中国程序员就别写英文注释了!
不要写“太牛逼”的代码!
"傻瓜式代码"!="低性能代码”
=========华丽的分界线==========
程序员同志们大多都会有这样的经历,就是要看别人的代码。比如说公司有同事离职了,他的那块业务就需要有其它的小伙伴们给接下来继续维护。这对好多程序员来说是种折磨,边看边骂,这写的是什么东西呀。相信好多人都有这种经历。
图片来之互联网
那么为啥会出现这样一个局面哦,其实这里面有很多讲究的地方了,如果不注意的话,不光是看不懂别人写的代码,即使是自己写的代码,几个月后你再去瞧瞧,你也会发蒙,那么接下来就分析一下这种情况形成的原因及怎么去解决它们。
局面形成的原因
面向过程去写代码
写代码前没有很好的对代码进行设计,完全是随心所欲去实现,对自己要求比较低,就是“能实现功能就可以了”这种心态去写代码。这样的代码将是十分不好维护的,别说以后让别人来维护这份代码了,即使几个月后的自己也是非常困难才能读懂自己的代码了。
代码没有注释
代码注释是对读取代码有着非常好的辅助作用,是其他人能够快速的了解代码功能,同时对自己以后回头来看自己的代码也是十分有帮助的。没有注释的代码就像深夜车灯坏了的汽车一样,虽然能行驶,但是你敢开快么?
代码变量名称随意
比如什么abc,temp这类变量,这是让谁看的呀,不根据代码的上下文谁也不知道这是啥意思哈,如果代码的上下文中全是类似这样的变量,我估计看代码的人会疯掉了。
每个方法分工不明确
一个方法中夹杂着多种功能,让人看了之后很难说出这个方法是干啥的,也不敢轻易去改动。
破除这种局面
不论为自己,让以后自己能看懂自己的代码,还是为别人能看懂自己的代码,让自己不挨骂,那么就推荐以下几种方法来规范自己的代码,让别人或者是自己能够轻轻松松看懂自己的代码
实现功能前先设计好代码
最好是面向对象的方式编程,不论是java还是php都能很好的应用面向对象的方式进行编程,设计好文件名,类名,以及方法名,不论是文件名,还是类名,方法名都要做到见名知意,要用标准的英文去表示,需要用多个英文表示就用驼峰标识来表达。让人看上去结构一目了然,代码看上去让人赏心悦目。
注释写的尽量详细
每个类,每个方法都要写明注释,类的注释可以简明写这个类的主要功能,但是每个方法的注释尽量要写细了,注释一定要覆盖方法中所实现的所有功能,而不是只写其中一部分。看过系统级源码的程序员都知道,注释的行数是比代码的行数还要多的。这就是优秀的习惯,我们也要去学习。
不要随便定义临时变量
尽量不要定义一些临时变量,如果十分必要定义时,最好时加上单行注释,让其他人知道你的意图。
不要写过长的方法
每个方法最好不要超过行代码,如果过长了,可以考虑该方法的功能点是否可以再次拆分,最好是一个方法就实现单一一个功能,这样的话方法的复用率也会提高的。
不要写太“牛逼”的代码了
有的程序员喜欢写非常个性的代码,喜欢写一些别人很难看懂的代码,他认为这样才能显示出自己的“高水平”,这样就不是高水平了,只能说代码的可读性太差了,我们要写出傻瓜式代码,也就是说让很傻的程序员都能看懂,"傻瓜式代码"!="低性能代码”哈,这一点要分开。
中国人就别写英文注释了
好多国内的程序员给代码写注释用英文写,如果英文非常好的话写英文注释那当然是无可厚非,如果你英文不好,就是为了装13的话,那么还是劝你别写英文注释了,你这不是在折磨自己也折磨别人嘛。让我记得最荒唐的一个程序员的做法是,他为代码写了汉语注释,然后用百度翻译把它翻译成英语贴到自己的代码里,呵呵,这哥们也够逗的了。
大家好,我是“上世是朵花”。如果你有什么好的看法或者观点可以在评论区展现你的才华,互动交流,如果想进一步了解我,那就