标签:
关于结对代码复审
项目数据库交互部分结构如下:
其中:
1、MySqlConn负责数据库的连接;
2、UserInfo为用户信息类,UserInfo映射为数据库中用户信息表,创建的一个个用户信息对象映射为用户信息表中的一条条记录;
3、IUserDao是提供的与数据库交互的接口,里面有两个方法,如下:
UserDao为实现IUserDao的类;
4、IUserService是提供的用户服务接口,里面有两个方法,如下:
UserService为实现IUserService的类。
在进行代码审查时发现如下问题:
1、 属性和方法命名规范采用的是小驼峰命名法,这在java中为主要规范,但在C#中,一般采用帕斯卡命名法,第一个单词的首字母也要大写。
2、 注释量不够,并且最好采用XML注释,所有的XML注释都在三个向前的斜线之后(///)。两条斜线表示是一个注释,编译器将忽略后面的内容。三条斜线告诉编译器,后面是XML注释,需要适当地处理。当开发人员输入三个向前的斜线后,Microsoft Visual Studio .NET IDE 自动检查它是否在类或者类成员的定义的前面。如果是的话,Visual Studio .NET IDE 将自动插入注释标记,开发人员只需要增加些额外的标记和值。下面就是在成员函数前增加三个斜线,自动增加的注释比如:
标签:
原文地址:http://www.cnblogs.com/huiling1809/p/5399612.html