欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页

如何编写高质量的代码

程序员文章站 2022-07-05 21:51:35
...

最近做这个项目,现在是测试,发现了许多问题,对于我,应该想一想,如何提高自己编写的代码的质量,尽可能少出bug

对于web项目:

第一点:web界面设计

当界面风格版式确定以后,需要做如下工作:

    1 确定页面上需要哪些控件,这些控件的重要属性,如状态,如只读性,如长度,可输入长度,如可见性。

    2.添加脚本验证逻辑,保证不会产生非法数据。

    3. 这些控件,哪些会有用户动作,这些动作会影响其他的控件的哪些属性,这些控件的状态会发生什么变化,显示什么数   据。
    

第二 :在编写代码之前一定要写详细设计,象编写代码一样,编写注释,作为详细设计。然后根据注释,写代码

       1。从url接收参数,要注意check

       2.从数据库读取数据要注意 无数据 和 null 两种情况。

       3. 赋值的时候,要注意数据类型转换,在做数据类型转换的时候,要注意被转换的数据,有多少种case,这些case在

         转换的时候会不会发生异常

       4.在把值显示到页面的时候,要注意应该显示什么格式,需不需要转换格式。

        5. 定义变量的时候,要注意类型,是不是应该定义为这种类型。

        6.编写有返回值的方法要保证每个路径都要有返回值。入口参数要检查,输入参数也要进行检查。

 第三: 在写访问数据库代码的时候注意如下事项

     首先要明确是否需要事务,应该把那些防到该事务里面。

      1.首先应该明确此项操作会涉及哪些表,在这里,建议把数据库设计文档浏览一遍,检查一遍,是否真的明确了。

      2.分别对这些表进行分析,明确对各个表的操作,更新,插入,还是删除,还是查询。在明确了以后,要再浏览一遍这个表,该项操作涉及对哪些字段,限制条件字段有那些。对于更新,更新哪些字段,限制字段有哪些。对于插入,需要把哪些字段插入,值是什么。当分析完一个表以后,要再分析一下,对这个表操作完以后,会影响哪些表,需不需要同步相关表。

   ---------------------注意主键

--------------------对于select 要注意按什么字段进行排序

   3。测试的时候有三步需要一一对应,插入之前数据、数据库的数据、在显示之前的数据。插入操作检查:记录条数。每个字段的数据都要一一对应。

第四: 学习TDD开发技术,以及web测试框架,以及单元测试工具。形成良好规范的编码风格,严格遵守。形成自己的编码流程。     

第五:编写代码的时候,不要一步就能编写出质量特别好的代码,要一固作气,先实现功能,再进行重构。

 第六: 修改代码:先想以下的范围(有类似的错误吗,相似的代码有类似的错误吗),然后再改动。

1.编写有输入参数的函数时要现进行防卫语句的编写,
2.当把某一个值赋予某个变量时,要注意右边的变量:
声明了吗?可能为空吗?可能为那些值?可能包含抛出异常或不合法的值吗?
3.对于包含session的程序,要注意何时赋予的值?何时清空它?
4.对于某项操作,要注意现保留现场,操作,清理现场(释放资源)

第七:用一个对象的时候一定要检查该对象是否为null