高质量JavaScript代码书写基本要点

核心提示：注释(Writing Comments)你必须注释你的代码，即使不会有其他人向你一样接触它，高质量JavaScript代码书写基本要点(19)，通常，当你深入研究一个问题，我爸不是李刚，所以要是翻译或表述有错请放心大胆地大力指正，你会很清楚的知道这个代码是干嘛用的，但是

注释(Writing Comments)
你必须注释你的代码，即使不会有其他人向你一样接触它。通常，当你深入研究一个问题，你会很清楚的知道这个代码是干嘛用的，但是，当你一周之后再回来看的时候，想必也要耗掉不少脑细胞去搞明白到底怎么工作的。

很显然，注释不能走极端：每个单独变量或是单独一行。但是，你通常应该记录所有的函数，它们的参数和返回值，或是任何不寻常的技术和方法。要想到注释可以给你代码未来的阅读者以诸多提示；阅读者需要的是（不要读太多的东西）仅注释和函数属性名来理解你的代码。例如，当你有五六行程序执行特定的任务，如果你提供了一行代码目的以及为什么在这里的描述的话，阅读者就可以直接跳过这段细节。没有硬性规定注释代码比，代码的某些部分（如正则表达式）可能注释要比代码多。

最重要的习惯，然而也是最难遵守的，就是保持注释的及时更新，因为过时的注释比没有注释更加的误导人。

关于作者（About the Author ）
Stoyan Stefanov是Yahoo!web开发人员，多个O'Reilly书籍的作者、投稿者和技术评审。他经常在会议和他的博客www.phpied.com上发表web开发主题的演讲。Stoyan还是smush.it图片优化工具的创造者，YUI贡献者，雅虎性能优化工具YSlow 2.0的架构设计师。

//zxx:以上就是翻译的全部内容，够长吧~~

译制人员结语
废话不多说。翻译水平拙劣，所以文中难免会有翻译不准确的地方，我爸不是李刚，所以要是翻译或表述有错请放心大胆地大力指正，不甚感谢。