良好的编程习惯(2011-11-08)

前一段时间有时间整理一个适合自己的编程习惯,当然这里仅为个人建议,朋友们可以根据自己的需要来看。欢迎补充哦。
1、避免使用大文件:绝大多数文件的代码不能超过300行(这是我对别人代码的要求,如果是对我自己的话,多数是类150行以内,函数代码不超过10行),必须将耦合的代码分开。 
2、避免使用太长的方法:绝大多数方法的代码在1-20行之间。 
3、方发名称需要能看出它做什么,名字不怕长,就怕短。 
4、尽量添加解释功能:接口需要最为详细的解释,公有类的公有方法也需要详细解释,程序集下、受保护的类及方法需要简单说明,除复杂私有函数外的私有函数可以不加注解。 
5、一个方法只能完成一个任务。即使该任务非常小(很多方法很有可能是一句话,不要嫌麻烦)。 
6、绝大多数方法的圈复杂度不能超过10,如果超过必须进行分解。 
7、不许在程序中使用固定数值,用常量或属性代替。 
8、不许使用字符串常数,用常量或属性,最好使用资源文件。 
9、尽量避免使用使用成员变量,应使用局部变量,并传递给方法,避免在方法间共享成员变量。 
10、使用enum,不许使用数字或字符串来指示离散值。 
11、 不许把成员变量声明为public,根据需要声明为private或者protected。 
12、尽量不在代码中使用具体路径和驱动器名, 使用相对路径,并可编程。 
13、如果需要配置文件找不到,需求可以的话尽量自己创建使用默认值的一份文件。 
14、显示给用户的消息简单而友好,但是要把所有异常信息在后台记录下来,以帮助诊断问题。 
15、显示错误信息,需要提示用户那里错了,并且需要告诉用户怎么解决问题。 
16、不许捕获了异常而什么都不做,应该进行处理,不许隐藏异常。 
17、 如果有单元测试中对于类中的public方法必须进行边界、空、正常值的组合测试,并且其代码覆盖率须为100%。如果有需求可对private等其他方法进行单元测试。 
18、事件的加载应该在控件数据完成装载后,而不是在控件创建时。
这里声明一下,感谢同事杨波的大力支持。

posted on 2012-02-13 10:13  张隽永  阅读(315)  评论(0编辑  收藏  举报