JavaScript 编码规范.doc

密级 内部公开密级 内部公开 文档编号 文档编号 NTT SD JSBCGFNTT SD JSBCGF 版本号 版本号 V1 0V1 0 JavaScriptJavaScript 编程规范编程规范 惠州市新中新电子技术开发有限公司惠州市新中新电子技术开发有限公司 编制 生效日期 审核 批准 惠州市新中新电子技术开发有限公司对本文件资料享受著作权及其它专属权 利 未经书面许可 不得将该等文件资料 其全部或任何部分 披露予任何 第三方 或进行修改后使用 JavaScript 编程规范 V1 0 XXXX 公司 版权所有 第 1 页 共 7 页 文文件件更更改改摘摘要要 日期日期版本号版本号修订说明修订说明修订人修订人审核人审核人批准人批准人 2008 08 09V0 1 创建 2008 10 08V1 0 正式版本 JavaScript 编程规范 V1 0 XXXX 公司 版权所有 第 2 页 共 7 页 目录 一 命名规范一 命名规范 4 1 一般文件及目录命名规范 4 2 变量命名规范 4 3 对象命名规范 5 4 函数命名规范 5 二 书写格式规范二 书写格式规范 6 1 变量使用规范 6 2 标记的缩进规范 6 3 注释规范 6 4 修改注释规范 7 JavaScript 编程规范 V1 0 XXXX 公司 版权所有 第 3 页 共 7 页 一 命名规范一 命名规范 1 1 一般文件及目录命名规范 一般文件及目录命名规范 A 公共函数 模块名 Common js 表示 其中 模块名的首字母应大写 例 如 客户模块公共函数文件命名为 Cus Common js B 列表显示 模块名 List js 表示 其中 模块名的首字母应大写 例如 客户列表模块文件命名为 CusList js C 增加操作 模块名 Add js 表示 其中 模块名的首字母应大写 例如 增加客户模块文件命名为 CusAdd js D 修改操作 模块名 Edit js 表示 其中 模块名的首字母应大写 例如 修改客户模块文件命名为 CusEdit js E 文件名中不能包含任何的空格 2 2 变量命名规范 变量命名规范 A 常量以及全局变量名必须全部使用大写字母 常数名中的多个单词使用下划 线 分隔 例如 var CONST ED SFA 系统错误 B 变量名除首字母小写外 其他单词首字符必须大写 并且必须采用有意义的 单词命名 例如 var oDate new Date var datStructCustType oXBDetail RequestData C 变量名必须使用其类型的所写字符串开始 各种类型的所写字符串如下 整型变量 int 长整型变量 lng 浮点型变量 flt 双精度变量 dbl 对象引用变量 obj 字符串变量 str Date 类型变量 dtm D 如果变量名过长可以使用单词缩写 推荐使用标准缩写以使名称保持在适当 的长度内 使用缩写时 应确保在整个脚本中保持一致 所有使用单词所写 的变量名必须在定义时给出注释 如 var strAdName 用于表示 Administrator 帐户的名称 var strAdminName 不用给出注释 Admin 被广泛了解 JavaScript 编程规范 V1 0 XXXX 公司 版权所有 第 4 页 共 7 页 3 3 对象命名规范 对象命名规范 A text 输入框 text 例如 B button 按钮 btn 例如 C select 下拉选择框 select 例如 D option 项 opt 例如 E form 表单 frm 例如 F frame 框架 frame 例如 G hidden 表单项 hidden 例如 H div 标记 div 例如 I span 标记 span 例如 0 4 4 函数命名规范 函数命名规范 A 函数命名必须使用动词 名词的方式 并且能够体现函数的功能 B 函数命名的动词前缀必须是同函数功能相关的完整动词 C 函数命名第一个单词的首字母大写 后面每一个单词的首字母大写 D 在 eCRM 系统中 函数命名为 l Func 操作 几个常用函数名称如下 页面初始化函数 lFuncDocumentReady 数据加载函数 lFuncDataReload 增加函数 lFuncAdd 修改函数 lFuncEdit 删除函数 lFuncDel 取消函数 lFuncCancel 二 书写格式规范二 书写格式规范 1 1 变量使用规范变量使用规范 A 变量使用前必须定义 没有定义的变量禁止使用 JavaScript 编程规范 V1 0 XXXX 公司 版权所有 第 5 页 共 7 页 B 变量的使用尽量缩小到小的作用域 如循环使用 for var I 0 I 12 I 而不是 var I for I 0 I 12 I 2 2 标记的缩进规范标记的缩进规范 A 一个 Tab 设置为 4 个空格键 B 最高一级的父标记采用左对齐顶格方式书写 C 下一级标记采用左对齐向右缩进一个 Tab 的方式书写 再下一级依此类推 分别左对齐相对于父标记向右缩进一个 Tab 的方式书写 D 同一级标记的首字符上下必须对齐 E 例子如下 function lFuncDataReload try if blnDataInit lFuncDocumentReady return true catch e return false 3 3 注释规范注释规范 A 所有过程的开始部分都应有描述其功能的简要注释 这些注释并不描述细节 信息 如何实现功能 这是因为细节有时要频繁更改 这样就可以避免不必 要的注释维护工作以及错误的注释 细节信息由代码本身及必要的内部注释 来描述 B 每个重要的变量声明都应有内部注释 描述变量的用途 C 应清楚地命名变量 控件和过程 仅在说明复杂细节时需要内部注释 D 应在脚本的开始部分包含描述该脚本的概述 列举对象 过程 运算法则 对话框和其他系统从属物 有时一段描述运算法则的注释是很容易让人理解 的 E 注释一行代码用 标识 并且书写在需要注释的上一行 例如 用于表示 Administrator 帐户的名称 var strAdName F 注释块用 标识 例如 JavaScript 编程规范 V1 0 XXXX 公司 版权所有 第 6 页 共 7 页 主题 创建潜在客户 作者 田博 描述 经纪人创建自己的潜在客户 公司 XXXX 有限公司 修改日志 日期 修改原因修改人 版本 2003 3 5 创建田博 version 1 0 4 4 修改注释规范修改注释规范 为了管理好源代码 每一次修改文件都要进行详细记录