js,方法注释规范

《js,方法注释规范》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、js,方法注释规范　　篇一：编码及注释规范(JavaScript)　　政府事业部长春公检法行业开发规范编码及注释规范（　　HTML/JavaScript）产品版本　　文档编号　　XX-05-31　　目录　　1共性规则........................................................................................................................................3　　2附录.............

2、...................................................................................................................................6　　1共性规则　　本规范中涉及命名、版式、表达式、基本语句及异常处理等一般开发方法的部分可直接参照《编码及注释规范(Java)》一文，本文中不再复述。本规范仅描述针对Html及JavaScript语言编程的特有约束项目。　　【规则1-1-1】HTML并不是一种编

3、程语言，而是一种标记语言，它没有任何真正的编程语言中的循环或是流程控制语句。然而，HTML代码的格式和风格是非常重要的，因为要经常对HTML代码进行维护和修改，因此HTML代码必须有很清晰的逻辑结构和布局，而使其易懂和易于维护。HTML文档通常具有如下的标准格式：　　　　　　yourtitlehere　　　　　　……　　　　　　【规则1-1-2】HTML语言是不区分大小写的，但XHTML对大小写是敏感的，对于XHTML而言，和是不同的标签。XHTML要求所有的标签和属性的名字都必须使用小写。例如：必须写成。大小写夹杂也是

4、不被认可的，通常dreamweaver自动生成的属性名字"onMouseOver"也必须修改成"onmouseover"。　　【规则1-1-3】一般一个HTML代码都会很长很复杂，因此不要把代码写得很密，这样的可读性非常差，HTML对回车和空格都不敏感，因此可以使用回车和空格，使代码的格式和结构更清晰，这样才能易于维护。很多标记一般来说要占用一行，除了同一标记的关闭标记外，最好不出现两个标记在同一行的情况。如：　　text　　应写成：　　　　　　text　　　　　　【规则1-1-4】所有的标记都应该被关闭，即使是HTML

5、不要求关闭的标签，如　　也应写成：。要特别注意不能出现标记交叉的情况，如：　　　　……　　【规则1-1-5】对于标记中的属性值，要使用双引号或单引号包围，这样的话不易出错。如：　　本来是希望在文本框中显示“Helloworld!”，但是由于没有加上引号，则只会在文本框中显示“Hello”，因此，正确地写法为：　　js,方法注释规范)gt;　　【规则1-1-6】最高一级的父标记采用左对齐顶格方式书写。下一级标记采用左对齐后，缩进2个空格的方式书写。再下一级则以此类推。同一级标记的首字符上下应对齐。　　例如：　　　　　　　　

6、………　　………　　　　　　　　　　………　　　　　　……　　　　　　【规则1-1-7】在任何代码中都应该有做注释的好习惯，在一个复杂的HTML代码中，友好的注释是非常有用的，特别是在有很多嵌套的表格中。HTML中使用来做注释。如：　　　　　　　　…………　　　　　　…………　　　　　　　　　　…………　　　　　　…………　　　　　　　　【规则1-1-8】如果多行相似的代码出现，属性尽量对齐　　　　　　　　　　type、name和value属性对齐以后阅读起来比较方便。　　【规则1-1-9】XHTML规定所有属性都必须有

7、一个值，没有值的就重复本身。例如：　　　　　　　　必须修改为：　　　　　　checked="checked">　　　　【规则1-1-10】任何小于号（＜），不是标签的一部分，都必须被编码为　　任何与号（&），不是实体的一部分的，都必须被编码为&　　【规则1-1-11】JavaScript程序应独立保存在后缀名为.js的文件中。除非这是段代码特定只属于此页面，否则JavaScript代码不应该被包含在HTML文件中。　　【规则1-1-12】脚本文件在页面中进行引用时的标准写法如下:　　　　样式表文件在页面中引用的标准写法是

8、：　　篇二：JS开发规范　　信息技术中心网站技术部JavaScript开发规范　　目录　　文件命名............................................................3代码外观.............................................