javascript书写规范.doc

Javascript书写规范:
1. 文件编码统一为utf-8;
2. 书写过程过, 每行代码结束必须有分号;
3. 库引入: 原则上仅引入jQuery库;
4. 变量命名: 以下划线链接每个单词,类型_变量名;
s:表示字符串;
n:表示数字;
b:表示逻辑;
a:表示数组;
r:表示正则表达式;
f:表示函数;
o:表示以上未涉及到的其他对象;
变量在作用域的顶部申明。
:全部大写,以下划线分隔  如网站的URL,域,图片目录路径,js和css用到的目录路径;
6. 类命名: 首字母大写, 驼峰式命名. ment;
7. 函数命名: 首字母小写驼峰式命名. 如getUserName();
,以下划线+方法名标注,私有方法不能在类外被调用。
9. 命名语义化, 尽可能利用英文单词或其缩写;
10. 代码结构明了化, 加适量注释. 提高函数重用率;
1)大功能区块的功能描述(类,函数)
/*
功能描述
参数描述
返回值
*/
2)单行的注释(放在行末尾)
//注释
11. 注重与html分离, 减小reflow, 注重性能.
,以j_classname的形式
,</body>的前面
(循环体中若有Dom操作,应该把Dom操作提到循环体外;在同一作用域内,Dom选择赋值给一局部变量。)

为了避免混乱,我们建议在HTML中使用双引号,在JavaScript中使用单引号。
//html
<img src="./blog/" />
//JavaScript
<script type="text/javascript">
('<p>');
</script>
//一段混用的jQuery代码
$('h1').after('<div id="content"><h2>目录</h2><ol></ol></div>');

//早期的代码可能是这样的
<script type="text/javascript" language="javascript">
...
</script>
//现在不用language属性了
<script type="text/javascript">
...
</script>

要检查你的方法输入的所有数据,一方面是为了安全性,另一方面也是为了可用性。用户随时随地都会输入错误的数据。这不是因为他们蠢,而是因为他们很忙,并且思考的方式跟你不同。用typeof方法来检测你的function接受的输入是否合法。
,js不直接控制css详细的设置,可控制classname
(.)
全局变量和全局函数是非常糟糕的。因为在一个页面中包含的所有JavaScript都在同一个域中运行。所以如果你的代码中声明了全局变量或者全局函数的话,后面的代码中载入的脚本文件中的同名变量和函数会覆盖掉(overwrite)你的。
//糟糕的全局变量和全局函数
var current = null;
function init(){...}
function change(){...}
function verify(){...}
解决办法有很多,Christian Heilmann建议的方法是:
//如果变量和函数不需要在“外面”引用,那么就可以使用一个没有名字的方法将他们全都包起来。
(function(){
  var current = null;
  function init(){...}
  function change(){...}
  function verify(){...}
})();
//如果变量和函数需要在“外面”引用,需要把你的变量和函数放在一个“命名空间”中
//我们这里用一个function做命名空间而不是一个var,因为在前者中声明function更简单,而且能保护隐私数据
myNameSpace = function(){
  var current = null;
  function init(){...}
  function change(){...}
  function verify(){...}
  //所有需要在命名空间外调用的函数和属性都要写在return里面
  retur