代码复审
Partner's ProjectAddress
项目功能
此项目为张天翊同学所写，其功能如下：
通过四个数字的形式输入起始坐标点，可以分别调用中点画线法，dda和BresenHam三个绘制直线的模块，都会返回需要点亮的坐标。
项目代码
def midPointLine(x0=-1,y0=0,x1=5,y1=4):
points = []
x0 = int(x0); y0 = int(y0)
x1 = int(x1); y1 = int(y1)
if x0 > x1:
x0, x1 = x1, x0
y0, y1 = y1, y0
print('x', 'y')
a = y0 - y1
b = x1 - x0
c = x0 * y1 - x1 * y0
x = x0; y = y0
k = (y0 - y1)/(x0 - x1)
if x0 == 0 and x1 == 0 :
for i in range(min(y0, y1), max(y0, y1) + 1, 1):
print(0, i)
points.append((0, i))
elif y0 == 0 and y1 == 0:
for i in range(min(x0, x1), max(x0, x1) + 1, 1):
print(i, 0)
points.append((i, 0))
elif k == 1:
for i in range(min(x0, x1), max(x0, x1) + 1, 1):
print(i, i)
points.append((i, i))
elif k == -1:
for i in range(min(x0, x1), max(x0, x1) + 1, 1):
print(i, -i)
points.append((i, -i))
elif k > 0 and k < 1:
d0 = 2*a + b
d1 = 2*a
d2 = 2*(a + b)
print(x, y)
points.append((x, y))
while x < x1:
if d0 < 0:
x += 1
y += 1
d0 += d2
else:
x += 1
d0 += d1
print(x, y)
points.append((x, y))
elif k > 1:
d0 = a + 2*b
d1 = 2*(a + b)
d2 = 2*b
print(x, y)
points.append((x, y))
while y < y1:
if d0 > 0:
x += 1
y += 1
d0 += d1
else:
y += 1
d0 += d2
print(x, y)
points.append((x, y))
elif k < -1:
d0 = a - 2*b
d1 = -2*b
d2 = 2*(a - b)
print(x, y)
points.append((x, y))
while y > y1:
if d0 < 0:
x += 1
y -= 1
d0 += d2
else:
y -= 1
d0 += d1
print(x, y)
points.append((x, y))
elif k > -1 and k < 0:
d0 = 2*a - b
d1 = 2*(a - b)
d2 = 2*a
print(x, y)
points.append((x, y))
while x < x1:
if d0 > 0:
x += 1
y -= 1
d0 += d1
else:
x += 1
d0 += d2
print(x, y)
points.append((x, y))
return points
def dda(x1=5, y1=12, x2=0, y2=0):
points = []
x1 = int(x1); y1 = int(y1)
x2 = int(x2); y2 = int(y2)
print('x', 'y')
print(x1, y1)
points.append((x1, y1))
if x1 == 0 and x2 == 0 :
for i in range(min(y1, y2), max(y1, y2) + 1, 1):
print(0, i)
points.append((0, i))
elif y1 == 0 and y2 == 0:
for i in range(min(x1, x2), max(x1, x2) + 1, 1):
print(i, 0)
points.append((i, 0))
else:
dx = x2 - x1; dy = y2 - y1
x = x1; y = y1
ep = max(abs(dx), abs(dy))
xIn = dx / ep; yIn = dy / ep
for i in range(0, ep + 1, 1):
print(int(x + 0.5), int(y + 0.5))
points.append((int(x + 0.5), int(y + 0.5)))
x += xIn
y += yIn
return points
def bresenHam(x1=-5, y1=1, x2=4, y2=-2):
if x1 > x2:
x1, x2 = x2, x1
y1, y2 = y2, y1
dx = x2 - x1
dy = y2 - y1
k = dy / dx
e = -0.5
x = x1; y = y1
points = []
print('x', 'y')
if x1 == 0 and x2 == 0:
for i in range(min(y1, y2), max(y1, y2) + 1, 1):
print(0, i)
points.append((0, i))
elif y1 == 0 and y2 == 0:
for i in range(min(x1, x2), max(x1, x2) + 1, 1):
print(i, 0)
points.append((i, 0))
elif k == 1:
for i in range(min(x1, x2), max(x1, x2) + 1, 1):
print(i, i)
points.append((i, i))
elif k == -1:
for i in range(min(x1, x2), max(x1, x2) + 1, 1):
print(i, -i)
points.append((i, -i))
elif k > 0 and k < 1:
for i in range(0, abs(dx)+1, 1):
print(x, y)
points.append((x, y))
x += 1
e += k
if e >= 0:
y += 1
e -= 1
elif k > 1:
for i in range(0, abs(dy)+1, 1):
print(x, y)
points.append((x, y))
y += 1
e += 1/k
if e >= 0:
x += 1
e -= 1
elif k < -1:
for i in range(0, abs(dy)+1, 1):
print(x, y)
points.append((x, y))
y -= 1
e += 1/k
if e <= -1:
x += 1
e += 1
elif k > -1 and k < 0:
for i in range(0, abs(dx)+1, 1):
print(x, y)
points.append((x, y))
x += 1
e += k
if e <= -1:
y -= 1
e += 1
return points
if __name__ == "__main__":
pass代码审查表
| 模块名称 | 图形学绘制直线的三个方法 | ||
| 审查人 | 张家铭 | 审查日期 | 2019.4.22 |
| 代码名称 | CG.py | 代码作者 | 张天翊 |
| 文件结构 | |||
| 重要性 | 审查项 | 结论 | |
| 头文件和定义文件的名称是否合理？ | 符合python库引用方式 | ||
| 头文件和定义文件的目录结构是否合理？ | 合理 | ||
| 版权和版本声明是否完整？ | 并无版权和版本申明 | ||
| 重要 | 头文件是否使用了 ifndef/define/endif 预处理块? | 无预处理块 | |
| 头文件中是否只存放“声明”而不存放“定义” | 否 | ||
| 程序的版式 | |||
| 重要性 | 审查项 | 结论 | |
| 空行是否得体？ | 程序空行较为得体 | ||
| 代码行内的空格是否得体？ | 较为得体 | ||
| 长行拆分是否得体？ | 得体 | ||
| “{” 和 “}” 是否各占一行并且对齐于同一列？ | 无 | ||
| 重要 | 一行代码是否只做一件事？如只定义一个变量，只写一条语句。 | 存在部分语句过于冗余 | |
| 重要 | If、for、while、do等语句自占一行，不论执行语句多少都要加 “{}”。 | 无 | |
| 重要 | 在定义变量（或参数）时，是否将修饰符 * 和 ＆ 紧靠变量名？注释是否清晰并且必要？ | 无 | |
| 重要 | 注释是否有错误或者可能导致误解？ | 注释过少 | |
| 重要 | 类结构的public, protected, private顺序是否在所有的程序中保持一致？ | 无 | |
| 命名规则 | |||
| 重要性 | 审查项 | 结论 | |
| 重要 | 命名规则是否与所采用的操作系统或开发工具的风格保持一致？ | 较为符合命名规则 | |
| 标识符是否直观且可以拼读？ | 标识符较为直观 | ||
| 标识符的长度应当符合“min-length && max-information”原则？ | 符合 | ||
| 重要 | 程序中是否出现相同的局部变量和全部变量？ | 是 | |
| 类名、函数名、变量和参数、常量的书写格式是否遵循一定的规则？ | 无类 | ||
| 静态变量、全局变量、类的成员变量是否加前缀？ | 并没有添加前缀 | ||
| 表达式与基本语句 | |||
| 重要性 | 审查项 | 结论 | |
| 重要 | 如果代码行中的运算符比较多，是否已经用括号清楚地确定表达式的操作顺序？ | 并没有使用括号 | |
| 是否编写太复杂或者多用途的复合表达式？ | 没有编写 | ||
| 重要 | 是否将复合表达式与“真正的数学表达式”混淆？ | 否 | |
| 重要 | 是否用隐含错误的方式写if语句? 例如 | 没有 | |
| （1）将布尔变量直接与TRUE、FALSE或者1、0进行比较。 | 没有 | ||
| （2）将浮点变量用“==”或“！=”与任何数字比较。 | 没有 | ||
| （3）将指针变量用“==”或“！=”与NULL比较。 | 否 | ||
| 如果循环体内存在逻辑判断，并且循环次数很大，是否已经将逻辑判 | 无此情况 | ||
| 断移到循环体的外面？ | 无 | ||
| 重要 | Case语句的结尾是否忘了加break？ | 无Case语句 | |
| 重要 | 是否忘记写switch的default分支？ | 无 | |
| 重要 | 使用goto 语句时是否留下隐患? 例如跳过了某些对象的构造、变量的初始化、重要的计算等。 | 无 | |
| 常量 | |||
| 重要性 | 审查项 | 结论 | |
| 是否使用含义直观的常量来表示那些将在程序中多次出现的数字或字符串？ | 使用 | ||
| 在C++ 程序中，是否用const常量取代宏常量？ | 无 | ||
| 重要 | 如果某一常量与其它常量密切相关，是否在定义中包含了这种关系？ | 否 | |
| 是否误解了类中的const数据成员？因为const数据成员只在某个对象 | 否 | ||
| 生存期内是常量，而对于整个类而言却是可变的。 | 无 | ||
| 函数设计 | |||
| 重要性 | 审查项 | 结论 | |
| 参数的书写是否完整？不要贪图省事只写参数的类型而省略参数名字。 | 参数书写完整 | ||
| 参数命名、顺序是否合理？ | 参数命名，顺序合理 | ||
| 参数的个数是否太多？ | 参数的个数正常 | ||
| 是否使用类型和数目不确定的参数？ | 没有使用类型和数目不确定的参数 | ||
| 是否省略了函数返回值的类型？ | 是 | ||
| 函数名字与返回值类型在语义上是否冲突？ | 否 | ||
| 重要 | 是否将正常值和错误标志混在一起返回？正常值应当用输出参数获得，而错误标志用return语句返回。 | 否 | |
| 重要 | 在函数体的“入口处”，是否用assert对参数的有效性进行检查？ | 并没有对入口参数做非法检查 | |
| 重要 | 使用滥用了assert？ 例如混淆非法情况与错误情况，后者是必然存在的并且是一定要作出处理的。 | 否 | |
| 重要 | return语句是否返回指向“栈内存”的“指针”或者“引用”？ | 无 | |
| 是否使用const提高函数的健壮性？const可以强制保护函数的参数、返回值，甚至函数的定义体。“Use const whenever you need” | 否 | ||
| 内存管理 | |||
| 重要性 | 审查项 | 结论 | |
| 重要 | 用malloc或new申请内存之后，是否立即检查指针值是否为NULL？（防止使用指针值为NULL的内存） | ||
| 重要 | 是否忘记为数组和动态内存赋初值？（防止将未被初始化的内存作为右值使用） | 无 | |
| 重要 | 数组或指针的下标是否越界？ | 否 | |
| 重要 | 动态内存的申请与释放是否配对？（防止内存泄漏） | 无 | |
| 重要 | 是否有效地处理了“内存耗尽”问题？ | 无 | |
| 重要 | 是否修改“指向常量的指针”的内容？ | 无 | |
| 重要 | 是否出现野指针？例如（1）指针变量没有被初始化;（2）用free或delete释放了内存之后，忘记将指针设置为NULL。 | 无 | |
| 重要 | 是否将malloc/free 和 new/delete 混淆使用？ | 无 | |
| 重要 | malloc语句是否正确无误？例如字节数是否正确？类型转换是否正 确？ | 无 | |
| 重要 | 在创建与释放动态对象数组时，new/delete的语句是否正确无误？ | 无 | |
| 类的构造函数、析构函数和赋值函数 | |||
| 重要性 | 审查项 | 结论 | |
| 重要 | 是否违背编程规范而让C++ 编译器自动为类产生四个缺省的函数： | 无 | |
| （1）缺省的无参数构造函数； | 无 | ||
| （2）缺省的拷贝构造函数； | 无 | ||
| （3）缺省的析构函数； | 无 | ||
| （4）缺省的赋值函数。 | 无 | ||
| 重要 | 构造函数中是否遗漏了某些初始化工作？ | 无 | |
| 重要 | 是否正确地使用构造函数的初始化表？ | 无 | |
| 重要 | 析构函数中是否遗漏了某些清除工作？ | 析构函数 | |
| 是否错写、错用了拷贝构造函数和赋值函数？ | 无 | ||
| 重要 | 赋值函数一般分四个步骤： | 无 | |
| （1）检查自赋值； | 没有检查自赋值 | ||
| （2）释放原有内存资源； | 无 | ||
| （3）分配新的内存资源，并复制内容； | 无 | ||
| （4）返回 *this。是否遗漏了重要步骤？ | 无 | ||
| 重要 | 是否正确地编写了派生类的构造函数、析构函数、赋值函数？ | 无派生类的构造函数、析构函数、赋值函数 | |
| 注意事项： | |||
| （1）派生类不可能继承基类的构造函数、析构函数、赋值函数。 | 无 | ||
| （2）派生类的构造函数应在其初始化表里调用基类的构造函数。 | 无 | ||
| （3）基类与派生类的析构函数应该为虚（即加virtual关键字）。 | 无 | ||
| （4）在编写派生类的赋值函数时，注意不要忘记对基类的数据成员重新赋值 | 无 | ||
| 其它常见问题 | |||
| 重要性 | 审查项 | 结论 | |
| 重要 | 数据类型问题： | ||
| （１）变量的数据类型有错误吗？ | 变量的数据类型没有错误 | ||
| （２）存在不同数据类型的赋值吗？ | 不存在不同数据类型的赋值 | ||
| （３）存在不同数据类型的比较吗？ | 不存在不同数据类型的比较 | ||
| 重要 | 变量值问题： | ||
| （１）变量的初始化或缺省值有错误吗？ | 变量的初始化或缺省值没有错误 | ||
| （２）变量发生上溢或下溢吗？ | 变量没有发生上溢或下溢 | ||
| （３）变量的精度够吗？ | 变量精度足够 | ||
| 重要 | 逻辑判断问题： | ||
| （１）由于精度原因导致比较无效吗？ | 否 | ||
| （２）表达式中的优先级有误吗？ | 表达式中优先级无误 | ||
| （３）逻辑判断结果颠倒吗？ | 否 | ||
| 重要 | 循环问题： | ||
| （１）循环终止条件不正确吗？ | 循环终止条件正确 | ||
| （２）无法正常终止（死循环）吗？ | 不存在 | ||
| （３）错误地修改循环变量吗？ | 否 | ||
| （４）存在误差累积吗？ | 没有误差的累积 | ||
| 重要 | 错误处理问题： | ||
| （１）忘记进行错误处理吗？ | 没有忘记进行错误处理 | ||
| （２）错误处理程序块一直没有机会被运行？ | 否 | ||
| （３）错误处理程序块本身就有毛病吗？如报告的错误与实际错误不一致，处理方式不正确等等。 | 无 | ||
| （４）错误处理程序块是“马后炮”吗？如在被它被调用之前软件已经出错。 | 无 | ||
评价
通过结合代码审查表对张天翊同学的代码进行审查，我发现了不少闪光点以及不足的地方。此项目虽然并不复杂，但是也可以看出其编码是有一定功底的，代码思路清晰，调用过程简介明了，并且较为符合PEP-8编码规范。
该软件是实现了计算机图形学中的构造直线算法，具体由中点画线法、dda算法和BresenHam算法。分别使用三个模块来实现，通过传入两个点的坐标，模块会返回一个以元组为元素的列表，表示需要被“点亮”的点。
不足的地方：
- 代码中没有版本以及版权申明。
- 部分语句过于冗余。
- 代码注释较少。
- 静态变量、全局变量、类的成员变量没有添加前缀。
- 模块中入口参数没有进行非法检查。
值得学习的地方：
- 头文件的引用符合python规范，先是系统文件，后是自定义库。
- 程序空行得体，符合PEP-8编码规范。
- Switch语句中，一定要编写default语句。
- 函数中参数的参数书写完整。
- 使用for循环进行遍历，可以大大减少死循环发生的可能性。
样例点评：
这里选取了dda算法模块，模块的入口参数为四个数字，分别表示了两个坐标值，
- 对于参数检查这一块，只是用了强制类型转化进行了简单的处理，但是效果并不是很好，如果传入的参数为字符类型，那么就很麻烦了。
- 对于直线段的绘制，这里首先进行了简单的筛选，将斜率为0以及斜率不存在的点进行了特殊操作，在这里选择点的for函数中，min和max两个函数使得代码段虽然很简洁，但是没有考虑到会执行很多次，带来很大的开销。
- 注释太少，尤其是处理一般情况时，倘若不添加注释，很难看清在做什么。
def dda(x1=5, y1=12, x2=0, y2=0):
points = []
x1 = int(x1); y1 = int(y1)
x2 = int(x2); y2 = int(y2)
print('x', 'y')
print(x1, y1)
points.append((x1, y1))
if x1 == 0 and x2 == 0 :
for i in range(min(y1, y2), max(y1, y2) + 1, 1):
print(0, i)
points.append((0, i))
elif y1 == 0 and y2 == 0:
for i in range(min(x1, x2), max(x1, x2) + 1, 1):
print(i, 0)
points.append((i, 0))
else:
dx = x2 - x1; dy = y2 - y1
x = x1; y = y1
ep = max(abs(dx), abs(dy))
xIn = dx / ep; yIn = dy / ep
for i in range(0, ep + 1, 1):
print(int(x + 0.5), int(y + 0.5))
points.append((int(x + 0.5), int(y + 0.5)))
x += xIn
y += yIn
return points通过此次代码审查的过程，我学习到了代码审查表中的一些要求，并且其中一些要求我发现我以前并没有做到，其实，以前根本没有发现有代码审查表这个东西。虽然这次使用的是C++的代码审查表，而实际中项目的编写使用是Python语言，但是，语言中的核心内容还是很相似的。
参考资料
- C++代码审查表