文章3部分 软件开发工作总结
代码的第一印象
我们都非常注重给别人的第一印象,也有非常多书籍教我们如何给别人留下一个美好印象的。
确实,假设我们第一眼看到某个人,就认为非常不爽,那么一定会在心理上产生抵触。以后再见到他,会有一种疏远的感觉。也正由于如此。当今社会交往中的“面子project”非常重要。无论如何,先撑足了自己的脸面再说。
代码也一样,也会给别人留下或好或差的印象。
当我们看到优美的代码时,会有一种想继续研究下去的欲望,甚至会有一种认为非常享受的感觉。
相反。当我们看到丑陋的代码时,就会咬牙切齿。由于它不仅不利于阅读,还会浪费我们非常多时间。减少我们做事的效率。人人都想写出好的代码,就像大家都想考试取得好成绩一样。可是,在实际工作中。有非常多因素使得我们心有余而力不足,想把事情做好。结果却事与愿违。
一般说来。代码给我们的第一印象有例如以下几种:
排版工整 VS 排版不工整
我们打开一个代码文件的时候,最先看到的就是其排版如何,这也是最直观的感觉。
当代码排版工整时,我们非常easy找出其条理和逻辑,会非常快理解其究竟要实现什么功能;而排版不工整的时候,我们的眼睛会认为非常累,进而影响了我们的思维。
排版工整的代码形式例如以下:
代码段A
代码段B
代码段C
代码段D
排版不工整的代码形式例如以下:
代码段A
代码段B
代码段C
代码段D
命名规范 VS 命名不规范
在看完排版之后,我们就会看到每一个函数和变量的命名。由于一般项目的代码行数都比較多,我们不可能花非常多时间去理解每一个函数和变量究竟是何用意,究竟是拿来做什么的。这就要求我们在编码的时候,使函数和变量的命名具有自说明性,让它们自己告诉读者是做什么用的。而不是要别人花大量时间去研读后才干知道。这在一定程度上反映了开发者的态度和专业化程度。
比如,一个处理消息的函数,命名为ProcessMsg和FunctionA。哪个更好呢?显然是前者。
我们仅仅要一看到其名字,就知道它是做什么用的。
再如。有三个变量。命名为LoopFlag、MaxNum、SumOfTwoNum,我们就能一下子明确它们有何用途。第一个变量用于作为循环标志。第二个变量用来存放最大数,第三个变量用来存放两个数之和。这太明显了。你都可以不用去问元芳。自己就能搞清楚。而假设相同三个变量,命名为i、j、k,你就无法一眼看出它们究竟有什么用,还要花大量的时间去阅读代码,甚至用几个小时的时间。你还不知道它们有何用途。这时,你的老大来问你事情做得如何,你照实一说,他便说你无能。
事实上你是“哑巴吃黄连”,怪就怪别人没有把代码写好。
凝视得当 VS 凝视不得当
第一眼看到代码,我们还会注意到其是否有凝视。凝视多还是少。
这也是非常直观的。
假设代码实现的功能较为复杂。那么加入凝视是不可缺少的。在恰当的地方,使用恰当的凝视。可以让读者认为思路豁然开朗,他们会默默地在心里感激你。凝视过少或没有凝视是不行的,就像我们吃饭一样。假设一碗青菜里面什么也没有,你会认为非常乏味,没有食欲。假设放上一点辣椒酱。就会认为食欲倍增。
无论你信不信,反正我是信了。
可是,凝视也不能过多,不能将实用的代码掩盖住了,不可以喧宾夺主。让真正实现功能的代码成了陪衬。
马克思教导我们“凡事都要有个度”,就是这个道理。
良好的凝视形式例如以下:
// 凝视A
{
语句块A
}
// 凝视B
{
语句块B
}
// 凝视C開始
语句D
语句E
语句F
// 凝视C结束
有了代码给我们的好的第一印象。接下去的工作就要好办多了。
在实际开发中,我就有这种经验:当接手到优美的代码时,自己就会为之振奋,会花费较少的时间而将任务完毕得非常好。我想,没有人想接手一个烂摊子,不仅影响开发进度。还影响心情。或许你当天是高高兴兴来上班的,但好心情就毁于烂代码之手。你说,是值,还是不值?
为了给别人留下好印象,我们一定要首先让自己的代码给别人一个好的第一印象。这也是培养团队凝聚力的一个非常好的方法。
(本人微博:http://weibo.com/zhouzxi?topnav=1&wvr=5,我们聊天号码:245924426,欢迎关注。)
版权声明:本文博客原创文章,博客,未经同意,不得转载。