代码抽查小结.ppt

代码抽查问题小结 （一）通用的规范性问题 （1）类的注释、方法的注释不全或不对 例如：@author的问题 规范的写法： 代码中的比较好的做法： 方法的注释：主要是@param、@return、@throws （2）Form和VO、PO中的set方法中没有判断null和去空格，以及定义String属性时没有赋空串 正确的做法： （3）代码中的打印没有去掉 （4）代码的注释问题 （5）变量命名过于简单、不能用数字 （6）没有用到的语句要删除（7）import不能导“*” 包括JAVA文件和页面 （8）日期和String的转换尽量不要放在Action 中（可以放在数据封装类或Form中）（9）Form中定义的对象尽量在reset方法中 new （二）工单和事业部的规范性问题 （1）Action中的方法不能传form，同时自己写的 方法要定义为私有 （3）return要放在try块中 （4）注意抛出的异常 一是代码中不能抛出SQLException异常；二是应该抛 出 ObjectAlreadyExistException和 ObjectNotExistException异常的却没有抛出。其中 update和delete方法要抛出ObjectNotExistException 异常，add方法要抛出ObjectAlreadyExistException 异常，对于get方法抛出ObjectNotExistException异 常，。 （注：这里的get方法返回 VO或PO,不是 List） （三）非规范性问题 （1）影响代码执行效率的问题 修改后： （2）存在错误但是测试无法测出的问题 （3）运行可能出现的错误 * * 没有规矩不成方圆 软件工艺中心：张根波 2005-08-11 另外注意注释中的“代码走查人”： @checker 这种情况现在已经比较少了。 这样的注释现在较多，这些PE在分解的时候写的代码步骤，尽可能改成自己的话，如果本身便于理解也可以不修改，但是如果具体的代码和这些注释不一样，则一定要修改。 （2） PreparedStatement和ResultSet不能定义为DAO的私 有成员 错误的 正确的 （5）扑获Throwable后，要在catch中区分是那种异常 正确的做法： （如果只抛出一种异常也请尽量这样 做） 修改前： 得到的改善： （1）代码量减少 （2）不用日期和String来回的转换， 提高了可读性，同时避免了定 义SimpleDateFormat变量时的 变量名称问题 （3）提高了代码的执行效率 修改前： 修改后： 修改前：存在可能重复回滚和重复打 印的可能 修改后：不但避免了重复回滚和重复 打印的问题，而且代码量减 少同时更加清晰可读 修改前： 修改后： 修改前：有可能在List中set进Null， 这就会在页面迭代的时候 出现空指针异常。 修改后：避免了这种情况。 *