Last updated 2 years ago
注释有时确实会过时,但这在实践中不一定是一个大问题。使文档保持最新并不需要付出巨大的努力。只有当代码发生了巨大的变更时,才需要对文档进行大规模的变更,而代码的变更将比文档的变更花费更多的时间。讨论了如何组织文档,使其在代码修改后尽可能容易地保持更新(关键的想法是避免重复的文档,并使文档靠近相应的代码)。代码审查提供了一个很好的机制来检测和修复陈旧的注释。