一.多使用有意义的命名,多创建短小的函数

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);
}

提醒:一般写函数,都是到什么就写什么(因为我们不是超人),这个不要紧,大家都一样。不过,写好后,一定要注意要优化, 写出容易让人看懂的代码。

如果您发现本文对你有所帮助,如果您认为其他人也可能受益,请把它分享出去。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 202,723评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,080评论 2 379
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 149,604评论 0 335
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,440评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,431评论 5 364
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,499评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,893评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,541评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,751评论 1 296
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,547评论 2 319
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,619评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,320评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,890评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,896评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,137评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,796评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,335评论 2 342

推荐阅读更多精彩内容