好的注释可以使我们更好地维护代码,一段时间之后依然可以更高效地回到代码高效开发。注释这些内容: 整体架构,高层次的观点。 函数的用法。 重要的解决方案,特别是在不是很明显时。避免注释: 描述“代码如何工作”和“代码做了什么”。 避免在代码已经足够简单或代码有很好的自描述性而不需要注释的情况下,还写些没必要的注释。注释也被用于一些如 JSDoc3 等文档自动生成工具:它们读取注释然后生成 HTML 文档(或者其他格式的文档)。