编码及注释规范(JavaScript)编码及注释规范(JavaScript).docVIP

编码及注释规范（HTML / JavaScript） 产品版本 1.0 文档编号 2011-05-31 目录 1共性规则 3 2附录 6 1共性规则 本规范中涉及命名、版式、表达式、基本语句及异常处理等一般开发方法的部分可直接参照《编码及注释规范(Java)》 【规则1-1-1】 HTML并不是一种编程语言，而是一种标记语言，它没有任何真正的编程语言中的循环或是流程控制语句。然而，HTML代码的格式和风格是非常重要的，因为要经常对HTML代码进行维护和修改，因此HTML代码必须有很清晰的逻辑结构和布局，而使其易懂和易于维护。HTML文档通常具有如下的标准格式： html head titleyour title here/title /head body …… /body /html 【规则1-1-2】 HTML语言是不区分大小写的，但XHTML对大小写是敏感的，对于XHTML 而言，title和TITLE是不同的标签。XHTML要求所有的标签和属性的名字都必须使用小写。例如：BODY必须写成body 。大小写夹杂也是不被认可的，通常dreamweaver自动生成的属性名字onMouseOver也必须修改成onmouseover。 【规则1-1-3】 一般一个HTML代码都会很长很复杂，因此不要把代码写得很密，这样的可读性非常差，HTML对回车和空格都不敏感，因此可以使用回车和空格，使代码的格式和结构更清晰，这样才能易于维护。很多标记一般来说要占用一行，除了同一标记的关闭标记外，最好不出现两个标记在同一行的情况。如： tabletrtdtext/td/tr/table 应写成：table??? tr??????? tdtext/td??? /tr/table 【规则1-1-4】所有的标记都应该被关闭，即使是 HTML 不要求关闭的标签，如 br 也应写成：br /。要特别注意不能出现标记交叉的情况，如： font……/p/font 【规则1-1-5】对于标记中的属性值，使用双引号或单引号包围，这样的话不易出错。如： ?type=text? value=Hello?World! ?length=20 本来是希望在文本框中显示“Hello world!”，但是由于没有加上引号，则只会在文本框中显示“Hello”，因此，正确地写法为： ?type=text ?value=Hello World! ?length=20 【规则1-1-6】 最高一级的父标记采用左对齐顶格方式书写。下一级标记采用左对齐后，缩进2个空格的方式书写。再下一级则以此类推。 同一级标记的首字符上下应对齐。例如： table? ??tr????? ??td?…?…?…?/td??????? td?…?…?…?/td??? /tr??? tr??????? td??????????? table????????????? …?…?…???????????? /table??????? /td??????? td?…?…?/td??? /tr/table 【规则1-1-7】在任何代码中都应该有做注释的好习惯，在一个复杂的HTML代码中，友好的注释是非常有用的，特别是在有很多嵌套的表格中。HTML中使用!--… … --来做注释。如： ??? tr???!--?ROW?1--??????? td??????!--?COL?1--???????? ……?……??????? /td??????? td??????!--?COL?2--???????? ……?……??????? /td??? /tr??? tr???!--?ROW?2--??????? td??????!--?COL?1--???????? ……?……??????? /td??????? td??????!--?COL?2--???????? ……?……??????? /td??? /tr/table 【规则1-1-8】如果多行相似的代码出现，属性尽量对齐 input type=hidden name=ProjectID value={$ProjectID} / input type=hidden name=ModuleID value={$ModuleID} / input type=hidden name=BugID value={$BugID} / input type=hidden name=AssignedTo value={$AssignedTo} / type、name和value属性对齐以后阅读起来比较