15.5 早期注释是否成本过高?
现在让我们重新审视一下延迟写注释的论点,即它避免了随着代码的发展而重写注释的成本。一个简单的粗略计算就能表明,这并不能节省多少。首先,估计一下你花在输入代码和注释上的总开发时间,包括修改代码和注释的时间;这不太可能超过所有开发时间的10%。即使你全部代码行的一半是注释,写注释可能也不会超过你全部开发时间的5%。将注释推迟到最后,只能节省其中的一小部分,这并不是非常多。
先写注释意味着在你开始写代码之前,抽象会更加稳定。这可能会节省编码时的时间。相反,如果你先写代码,抽象可能会随着你的编码而发展,这将需要比注释优先的方法更多的代码修改。当你考虑到所有这些因素时,有可能总体上先写注释会更快。
Last updated