2016年11月13日
一.原则:尽早优化代码,写容易让人家读懂的代码
1.a place for everything, and everything in its place.
糟糕的代码会毁了一家公司。(以后会越来越不容易维护,你现在不优化,以后也不会优化。)
写容易读懂的代码,比可以运行的代码重要的多。
其实在写代码时间很少,多半花在读懂比人的代码,多写点别人能读懂的代码吧。
二.取个有意义的命名
1.知其名知其义
//错误
int d; //消失的时间,以日计算
//推荐
int elapsedTimeInDays; //消失的时间,以日计算
2.不要用误导性的变量命名,比如小写l 和 大写O,
3.少用 a1, a2 这类命名
4.多用可以读的单词
//错误
Date genymdhms;
//正确
Date generateTimestamp;//生产时间戳
三.函数
1.每个函数尽量只做一件事。
2.函数自上而下的阅读习惯(子函数在原函数的下面)
3.描述性语言(名字阐述了函数所做的事)就当讲故事就可以
//eg1
inclueSetupAndTeardownPage()
//eg2
checkPassword();//只检查密码
checkPasswordAndInitializeSession();//检查密码同事初始化
4.函数参数不要大于3个,大于就封装成类。3个以上太不容易看懂了。
//一般
Circle makeCircle(double x, double y, double radius);
//推荐
Circle makeCircle(Point center, double radius);
5.函数要么do something ,要么reply something,最好不要两者混合起来。
//不推荐
if(setAndCheckIfExists(“username”,”wangyu”)) //
//推荐
if(attributeExists(“username”)) //如果存在该属性,就设置该值。
{
setAttribute(“username”,wangyu);
}
提醒:一般写函数,都是到什么就写什么(因为我们不是超人),这个不要紧,大家都一样。不过,写好后,一定要注意要优化, 写出容易让人看懂的代码。
如果您发现本文对你有所帮助,如果您认为其他人也可能受益,请把它分享出去。