(JS开发规范.docVIP

信息技术中心网站技术部 JavaScript开发规范 版本 更新时间 修改人 备注 V1.0 2013 ？？ 文档创建 目 录 文件命名 3 代码外观 3 注释规范 4 命名规范 4 语句规范 5 注意事项 7 参考资料 文件命名 JavaScript程序应该作为一个.js文件存储和发布。 文件名全小写，标记版本号和特性说明，扩展名小写，例如search1.1-src.js。 JavaScript代码尽量不要嵌入在HTML中 文件开始包含类似以下注释说明 /******************************************** // 文件名： // 文件功能描述： // 创建人： // 创建时间： // 描述： // 修改人： // 修改时间： // 修改描述： //******************************************/ 文件功能描述着重于描述文件功能与说明，详情应在类的注释中描述。 一天内有多个修改只需做做一个修改标识，在所有的代码修改处加上修改标识的注释。 代码外观 列宽 代码列宽控制在100字符左右。 换行 当表达式超出或即将超出规定的列宽，遵循以下规则进行换行 在逗号后换行。 在操作符前换行。 规则1优先于规则2。 缩进 缩进应该是每行一个Tab(4个空格)，不要在代码中使用Tab字符。 空行 空行是为了将逻辑上相关联的代码分块，以下情况应加入一个空行。 类与类的定义之间。 方法与方法、属性与属性之间。 方法中不同的逻辑块之间。 注释与它注释的语句间不空行，但与其他的语句间空一行。 空格 关键字和( 应该用空格隔开。 方法名和( 之间不要使用空格。 多个参数用逗号隔开，每个逗号后都应加一个空格。 语句中的表达式之间用空格隔开。 一元操作符和操作数之间不应该使用空格隔开，除了操作符是一个单词时，如typeof。 二元操作符，除了. 、 (和[，都应该使用一个空格来和操作数隔开。 for语句控制部分的;应该在后面跟一个空格。 括号 左括号( 不要紧靠关键字，中间用一个空格隔开。 左括号( 与方法名之间不要添加任何空格。 没有必要的话，不要在return语句中使用()。 花括号 左花括号{ 放于关键字或方法名的同一行末尾。 通常右花括号}独立成行，不与任何语句并列一行。 If、for、while、do等语句后必须使用{}，即使{}号中为空或只有一条语句。 右花括号}后加注释说明语句块结束。 变量声明 总是使用var声明变量。 一行只做一个声明。 在变量声明时就做初始化。 变量声明应置于块的开始位置。例外： for (var i = 0; i len; i++){ } 应避免不同层次间的变量重名。 方法内禁止定义和使用全局变量。 注释规范 注释应该是解释为什么和做什么，而不是介绍是什么。 总是使注释保持最新。 变量声明时，使用行尾注释；其他情况下，使用单行注释并于标识的代码对齐。 不注释难以理解的代码，而应该重写它。 避免多余的或不适当的注释。 对由循环和逻辑分支组成的代码使用注释。 使用具有一致的风格和语言书写注释。 用空白将注释同注释分隔符分开。在没有颜色提示的情况下查看注释时，这样做会使注释很明显且容易被找到。 命名规范 命名原则 命名由字母、数字和_组成。命名是为了帮助人们阅读。 避免使用系统保留字。 应选择正确的名称，能够表明功能或定义目的。 在编程上通过命名可以将各项明确的区分开来。 避免容易被主观解释的难懂的名称，避免歧义。 只要合适，在变量名的末尾或开头加计算限定符。 在一组相关变量的命名中使用互补对，如 min/max、begin/end 和 open/close。 布尔变量名应该包含 Is，这意味着 Yes/No 或 True/False 值。 在命名状态变量时，避免使用诸如单纯 Flag或Status 的术语。 不要使用匈牙利语表示法。 缩写 不要将缩写或缩略形式用作标识符名称的组成部分。 不要使用计算机领域中未被普遍接受的缩写。 在适当的时候，使用众所周知的缩写替换冗长的词组名称。如URL、HTML。 使用缩写时，对于超过两个字符长度的缩写请使用 Pascal 大小写或 Camel 大小写，但应当大写仅有两个字符的缩写，如System.IO而不是 System.Io。 不要在标识符或参数名称中使用缩写。 类名称 用名词或名词短语命名类 使用 Pascal 大小写。 用名词或名词短语命名类。 使用全称避免缩写，除非缩写已是一种公认的约定，如URL、HTML 不要使用类型前缀，不要使用下划线。 Namespace命名全部使