documentation - 评论总是错误的——对还是不对？

Question

关闭。这个问题是opinion-based .它目前不接受答案。












想改善这个问题吗？更新问题，以便可以通过 editing this post 用事实和引文回答问题.

3年前关闭。




Improve this question




随机跑到这个blog关于人们永远不应该阅读评论的方式，并且对自己认为我读过的所有评论要么是错误的，要么是过时的，要么只是令人困惑的。一个简单的人应该永远不会阅读评论和/或只是使用正则表达式替换模式来删除... :-) ...只是在开玩笑，但实际上，也许不是。至少看起来像注释，相关代码应该有时间戳。同意还是不同意？

仅供引用，博客似乎是由这个 stackoverflow 用户创建的:Nosredna

Answer 1

不准确的注释与错误的代码一样严重。如果这是一个持续存在的问题，我会说该项目存在严重问题。像PostgreSQL这样的大项目(src目录下94M解压)依靠准确的注释来帮助程序员快速理解事物。他们也非常重视评论。

编辑:

另外，如果你不能总结你的功能在做什么，那么谁可以呢？完成函数的编写后，为它编写注释可以测试您是否完全了解正在发生的事情。如果您的脑海中仍然有些困惑，那么当您尝试撰写评论时，它会变得非常明显。这是一件好事，它显示了仍然需要进行的工作。