6.3 - 在你的代码中添加引用
对于来自你所要实现的论文的每一条方程,你需要添加一段注释引用这篇论文(作者和时间)以及段落号码或方程号码。这样,以后重读代码时,你可以直接把代码和论文中的准确位置联系起来。这些注释就像:
// 参见 Cootes et al., 2001, 方程 2.3
// 参见 Matthews and Baker, 2004, 章节 4.1.2
6.4 - 在变量名中避免数学符号
我们假设一些数量在算法中是一个矩阵表示为A。然后,算法要求矩阵在两个维度上的梯度,表示位 dA = (dA/dx, dA/dy)。那么变量名不应当为"dA_dx"和"dA_dy",而是"gradient_x"和"gradient_y"。相似地,如果一个方程系统要求收敛判定,那么变量不应为"prev_da_dx"和"dA_dx",而是"error_previous"和"error_current"。把变量永远命名为它们所表示的物理数量,而不是论文作者使用的任何字母符号(例如"gradient_x"而不是"dA_dx"),并且永远要把更具体的表示写在左边(例如"gradient_x"而不是"x_gradient")。