Web前端编码规范_前端代码规范文档资源-CSDN文库

需积分: 16 46 浏览量 2011-12-13 01:21:00 上传评论 1 收藏 38KB DOC 举报

### Web前端编码规范知识点 #### JavaScript编码规范 1. **JS文件组织**： - 所有的JavaScript代码应当被组织在单独的`.js`文件中，并通过`<script type="text/javascript" src="xxx.js"></script>`的方式在HTML文档中引入。 - 避免在HTML文件中直接编写JavaScript代码。 2. **废弃属性**： - `<script>`标签中的`language`属性已被废弃，不应再使用。 3. **变量声明**： - 在使用任何变量之前都必须进行声明。 - 使用`var`关键字进行变量声明。 - 变量名只能由英文字母、数字、下划线“_”以及美元符号“$”组成，且首字符不能为数字。 4. **命名规则**： - 变量名一律使用小写字母，多个单词组成的变量名采用驼峰式命名法（例如`userName`）。 - 常量名全部使用大写字母，单词间使用下划线“_”分隔（例如`PAGE_SIZE`）。 5. **数字使用**： - 代码中避免直接使用数字，而应将其存储在变量或常量中。 6. **语句结束符**： - 每条语句的结尾必须使用分号“;”。 7. **代码长度限制**： - 单行语句不得超过80个字符，超出部分应换行。 8. **函数命名**： - 函数名通常以模块名加上功能描述命名，如`news_showDetail()`。 9. **数组与对象声明**： - 使用简化的语法声明数组和对象，例如：`var newArray = [];` 和 `var obj = {};`。 10. **代码缩进**： - 统一使用四个空格进行缩进。 - 不使用Tab键进行缩进，若需使用，则需设置软件中的Tab键为四个空格。 11. **代码格式**： - 遵循标准的代码格式，例如：`if (条件) { ... } else { ... }` 12. **注释**： - 代码中应合理使用注释，特别是对于复杂的功能性函数，以方便后期维护。 13. **类命名**： - 自定义类名首字母大写，以保持与JavaScript内置对象命名一致。 14. **浏览器检测**： - 避免使用`document.all`来判断是否为IE浏览器，可以使用其他方法，如`window.attachEvent`。 15. **安全问题**： - 尽量避免使用`eval()`函数，因为它可能引发安全问题。 16. **对象定义**： - 定义对象时，最后一个成员不应该添加逗号。 17. **代码检查**： - 编码完成后，使用工具如JSLint进行代码检查。 #### HTML编码规范 1. **文档类型声明**： - 所有HTML页面必须包含文档类型声明`<!DOCTYPE>`, 并置于文件的第一行。 - 示例：`<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">` 2. **标签大小写**： - 代码应遵循XHTML规范，所有标签都必须为小写。 3. **标签关闭**： - 所有标签均需正确关闭，即有开始标签和结束标签。 - 单个标签（如`<br>`）也需自关闭，例如`<br/>`。 4. **属性大小写**： - 所有属性名称必须为小写。 - 属性值必须用引号括起，推荐使用双引号。 5. **标记排布**： - 每个标记应独立占据一行，不允许两个标记出现在同一行（除了同一标记的闭合标记外）。 6. **标签嵌套**： - 不允许出现交叉嵌套的语句。 7. **图片alt属性**： - 图片元素必须包含`alt`属性，并提供与图片内容相关的描述。 8. **文件扩展名**： - 文件名后缀应统一使用`.html`。 9. **代码缩进**： - 使用四个空格进行缩进，对于Tab键的使用，需要在编辑器中设置为四个空格的宽度。通过以上JavaScript和HTML编码规范的详细介绍，我们可以看到这些规范不仅有助于提高代码的可读性和可维护性，还能够帮助开发者养成良好的编程习惯。遵循这些规范还可以减少代码中的潜在错误，确保代码的一致性和稳定性。此外，利用现代的代码检查工具如JSLint等，可以帮助开发者及时发现并修正不符合规范的问题。遵循一套清晰的编码规范对于提升项目的整体质量至关重要。

资源推荐

资源详情

资源评论