从此以后,写代码不能再是搭鸡窝

 

在米老师和学宇检查我们第一遍收费系统的时候.重点强调了写代码的规范.其中老师说道这么一句话很是让我震撼: 写代码是为了让别人看得,你写的代码能运行都不值得一提.

对呀!写代码是为了运行,这个阶段应该是我们去年做的事,现在我们逐步的用工程学的角度去设计,开发软件.写出来的代码绝不仅仅是能运行而已.

所以 我们的代码要符合一下规范:

1:首先能让别人不费很大力气的看得懂.

现在计算机硬件技术飞速发展,已近不是仅仅有几十K内存的时代了.所以很多的代码(不包括处理大量数据的代码)我们没有必要给他使用巧妙地算法.这样做的结果就是,你没有给计算机减轻多大压力.而是给你的合作伙伴增大了压力.他们的花费时间去设计你的理解你的代码(即使有注释)

我们尽量在不影响性能的基础上,使用简洁,通俗的设计.

并且非常重要的是对代码的注释,除了开发平台提供的必要XML注释之外.在每一个类的头部写出类的说明.具体如下:

*********************************************************

FileName:

Copyright  (c)  2010-单位名称

Writer: 作者

Create Date:

Rewriter:

Rewrite Date:

Impact:

Main Content（Function Name、parameters、returns）

同时对于程序中声明的变量,常量等要做好注释.

这样,在别人看程序的时候就会一目了然.你的合作伙伴会非常愿意和你合作.一个程序中,如果没有注释,那样这个程序就没有存在的必要.

2:代码应该能很好的复用性,扩展性

现在我们在逐步学习分层与设计模式,这样做的效果就是我们的程序有很好的复用性和扩展性,尤其是那些每一个软件都可能用到的功能,我们尽量把它提取出来.这样你在以后的开发过程中会效率大大提升.

比如对数据库处理产生的sqlHelper,可以在任何语言中使用他来处理同类的数据库.

3:代码一定要符合法律(文档)

无规矩不成方圆.如果你希望你的软件出色,必须一丝不苟的按照文档或者UML建模去实现.如果有不同的想法,在必须要改动设计文档的情况下,才由专人去改动.并且要严格记录改动情况.如:改动人,时间,原因,原需求等.

在其他情况下,要让自己的代码符合自己的设计,建模.建模就是法律,任何人到遵守.有了这个前提,我们的设计才能得到实现,我们才能做到言必行,行比果.

做到了以上三点,我们的代码才正在叫做程序,我们做的软件才是用砖块一块块砌起来的.不是用木棍搭起来的.程序才更结实,永久.