JSI Side 代码风格与规范

准备编写JSI的外围元素，先整理一下编码风格和一些约定，欢迎大家讨论。

基本风格

    * 基本参照Java代码风格。
         1. 驼峰式命名（单词无连接字符，单词首字母大写，其余小写）；
         2. 类的首字母大写(eg:MyClass)；
         3. 变量名，方法名，成员名首字母小写(eg:name,value,targetObject)；
         4. 单例对象遵循类的命名方式(eg:GlobalController)；
         5. 常量全部大写，下划线分割单词(eg:APPLICATION_ID)；

    参考：http://java.sun.com/docs/codeconv/

    * 变量所用单词尽量不用缩写。

    缩写的单词容易造成语意的不明，不易阅读，而且容易造成争议。

编码约定

    * 不要随意扩展原始对象。

    自Prototype 起，扩展原始对象似乎成了一个时髦的东西，大家都喜欢用。我承认他的便捷，但是请不要滥用，尽量做到有标准可循（比如为IE5扩展 Array.prototype.push），原始对象就这么几个，万一那天碰到两个人写的代码，行为不一致，那麻烦就大了。

    * 不要扩展Object.prototype。

    这个地雷貌似已经被头大牛踩到，但是你不要踩，谁踩到他，你就和他割席断交吧。

    * 不要盯上对象的constructor属性。

    constructor属性是非常不可靠的，很容易也经常被改写，而且经常被改写到Object对象[MyClass.prototype = {...}]，能后你以为是你的构造器，动之，能后天下大乱。

    * 不要写那些中看不中用的集合。

    不要模仿Java 集合API，去写什么 HashMap，ArrayList。JavaScript不相信这些，这个世界简单才是硬道理。

    * 在结构中始终使用区块。

    莫偷懒，省略区块（即{ }）会引发不经意的错误和麻烦。即使只有一句，也老老实实写上：

    * 单例模式直接使用对象申明。

    我们不需要那个不中用的构造函数, 不如直接来个对象申明，直接定义属性。

    * 变量名就是最好的文档。

    不要担心变量名称的长度,他们只是一个符号，符号的意义在于表明变量的意义，而大小的事就交给压缩工具吧。比如，可以使用thisPackage，targetPackage；而不要用pkg1，pkg2。

    * 表达式中赋值需要明确注释。

    直接在表达式中赋值可以使代码紧凑，但会降低程序可读性，应尽量避免，但是对于一些关键元素,可以采用（压缩/优化考虑），但必须明确注释。

    * 目录名以"/"结尾。

    JSI内核中，有一些地方需要记录目录地址。这里我们统一以“/”结尾。

    * 不要使用原始类型的对象量。

    原始对象有些诡异的地方，如。

      new String("test") != new String("test");
      if(new Boolean(false)){
        alert("执行到")
      }else{
        alert("未被执行")
      }

    对外接口可以考虑兼容，但是内部元素，不考虑，内部也不要使用这些对象。

    * 杜绝变量悬空现象

    不要出现:

    if (!window.Element){
        var Element = new Object();
    }

    改成：

    var Element = window.Element || new Object();

    这段代码来自大名鼎鼎的Prototype，这里没错，但是如果被拷贝到某个函数内，问题就大了，有此类问题的脚本，放在JSI中装载，也会存在问题。

一些诡异的技巧

    * {}就是Map

    哪简单对象当map是个非常方便的地方，缺点是key都被转化成string。但是大多数情况下还是够用的，简单就好，没必要复杂化。

    * []用作LinkedHashMap

    使用数组保存键的顺序，对象存储键的值，基本可以等价于LinkedHashMap结构。缺点是有上，同时，length不能为键。

    * 使用constructor == String代替typeof

    上面说到constructor不可靠，是的，但是constructor用来代替typeof，一般来说更可靠了。还可以同时做好对象类型和值类型的兼容。

    * 巧用与或。

      if(fn){

        fn();

      }

      -->

      fn&&fn();

慎用动态元素

    * eval

    eval的性能问题到不是主要的，主要理由依然是他的动态性，容易给程序带来不稳定因素。

    * with

    少用with，主要不是他的性能问题，其实with的性能问题并不太明显，但是他容易给程序带来不稳定因素。

    * execScript

    类似eval，ie上通行，不同之处在于他是一个上下文无关的eval，传入的脚本直接在全局上下文执行。

    * document.write

    当打印一段脚本标签时，近似等价与execScript

    * new Function

    不仅是动态元素，他同时还有一个上下文短路问题。

    * 少用属性。

    属性虽然是面向对象的常用元素，但JavaScript?属性的动态性太强，不便自动优化处理；同时属性的使用，将产生更多不稳定的状态，虽然貌似易于阅 读，却增加了程序的复杂性。实际编码中应该谨慎。常量性质的私有属性不要出现，能用变量的地方也不要随意升级为属性。

    * window.xyz

    有些人习惯用这个来申明全局变量，或者干脆不申明， 那么，改掉你的坏习惯。

评论

5 楼 jindw 2008-04-30  

s79 写道

"在结构中始终使用区块"，如果if、for的{}里真的只有一句，不妨省略并与if、for写在一行。这和下边的巧用||、&&一样紧凑易读。

虽然我依然坚持我自己的风格，但是，我觉得，你的提法也可以接受。
但是，换行的写法，我坚决反对，那样太伤眼睛^_^

s79 写道

"少用属性"，我觉得属性和方法一定是public的，可以供程序中其他模块或最终用户直接使用。不想公开属性或方法的就利用变量作用域做闭包，成为私有变量。

同意这个观点。那种下划线前缀的伪私有约定，其实并不怎么漂亮^_^
不过在JSI下，闭包就不必自己显式申明了。

s79 写道

"window.xyz"申明全局变量，和var xyz申明的全局变量不一样，var xyz申明的全局变量是不能用delete window.xyz删除的。一般调试程序的时候可以使用window.xyz来保存某个对象以便跟踪查看。

反对这种变量申明方式，因为，这个动态性太强，不便于自动工具处理与解析。当能， 在框架级别上还是可以考虑的，比如JSI导入的最后环节其实就是利用了这点。

4 楼 jindw 2008-04-30  

关于window.xx
我认为他是完全等价于申明的全局变量的。
这点ECMA里面也有明确说明，变量是某个scope的属性。而scope一般都是无法获取的，但是全局scope例外。他就是window，或者(function(){return this})()。

关于delete；
delete 是用来删除属性的，不是删除变量的，所有，我感觉和楼上的陈述刚好相反。

3 楼 csf178 2008-04-30  

事实上 delete window.xyz什么都做不了 哪种都没法删掉

有些时候window.xyz用来动态声明全局变量 不过有JSI的话当然就不需要了

2 楼 s79 2008-04-30  

<div class='quote_title'>jindw 写道</div>
<div class='quote_div'>
<p>...<br/>
<strong>
    * 在结构中始终使用区块。</strong>
<br/>
<br/>
    莫偷懒，省略区块（即{ }）会引发不经意的错误和麻烦。即使只有一句，也老老实实写上： </p>
<p>
...</p>
<p>    var Element = window.Element || new Object();</p>
<p>   fn&amp;&amp;fn();</p>
<p>...</p>
<p><br/>
<strong>
    * 少用属性。</strong>
<br/>
   
属性虽然是面向对象的常用元素，但JavaScript?属性的动态性太强，不便自动优化处理；同时属性的使用，将产生更多不稳定的状态，虽然貌似易于阅
读，却增加了程序的复杂性。实际编码中应该谨慎。常量性质的私有属性不要出现，能用变量的地方也不要随意升级为属性。 <br/>
...<br/>
<strong>
    * window.xyz</strong>
<br/>
<br/>
    有些人习惯用这个来申明全局变量，或者干脆不申明， 那么，改掉你的坏习惯。</p>
</div>
<p>对以上几点有不同意见或补充，如下：</p>
<p>"<strong>在结构中始终使用区块</strong>"，如果if、for的{}里真的只有一句，不妨省略并与if、for写在一行。这和下边的巧用||、&amp;&amp;一样紧凑易读。</p>
<p>"<strong>少用属性</strong>"，我觉得属性和方法一定是public的，可以供程序中其他模块或最终用户直接使用。不想公开属性或方法的就利用变量作用域做闭包，成为私有变量。</p>
<p>"<strong>window.xyz</strong>"申明全局变量，和var xyz申明的全局变量不一样，var xyz申明的全局变量是不能用delete window.xyz删除的。一般调试程序的时候可以使用window.xyz来保存某个对象以便跟踪查看。</p>
<p>其他地方完全支持楼主观点！</p>

1 楼 csf178 2008-04-29  

每一条都very good
没有任何问题