网络编程
位置:首页>> 网络编程>> JavaScript>> 如何编写高质量的Javascript代码(13)

如何编写高质量的Javascript代码(13)

 来源:rockux 发布时间:2011-03-07 16:04:00 

标签:javascript,代码,经验

还有其他几种表示私有成员的规范:

在末尾使用下划线,比如name_以及getElements_

使用一个下划线表示保护成员_protected,两个下划线表示私有成员__private

在firefox中,有些不是语言原生的变量,以两个下划线开始,两个下划线结束__proto__以及__parent__

写注释

必须给你的代码写注释,就算它看起来不会被别人接手。有时候,你研究完一个问题,然后你看着代码觉得那是显而易见的,但是过一两周之后回头再看,你也会摸不着头脑的。

当然,也不能过分的注释:每个变量每一行代码都注释。但是通常都需要对函数的功能,参数,返回值写文档,以及一些其他的复杂的逻辑和算法。想想,你的代码的阅读者,只需要读注释就能大体上了解你的代码在做什么需要什么,这比直接读代码理解要快的多。当你有五六行的代码是做一个具体的任务,那么阅读者就可以通过一行代码了解你的目的,然后跳过这些代码。关于注释,没有硬性的比例说是多少代码需要多少注释。有时候,有些代码(比如正则表达式)注释的内容肯定比代码本身多。

写注释是必须遵守的规范,而且要保持注释的更新,一个过时的注释带给人的迷惑还不如不写注释。

原文:http://net.tutsplus.com/tutorials/javascript-ajax/the-essentials-of-writing-high-quality-javascript/

0
投稿

猜你喜欢

手机版 网络编程 asp之家 www.aspxhome.com