《Java编码规范》由会员分享，可在线阅读，更多相关《Java编码规范（12页珍藏版）》请在金锄头文库上搜索。
1、JavaScript 编 码 规 范Version 1.2 -2-文档历史版本 日期 编者 注解 授权文档更新要点 版本 1.2 1. 对版本 1.1 中的“文件命名规定”部分做了大幅度地修改和完善。2. 新增了“关于页面中各个按钮的命名规定” 。 版本 1.1 1. 对版本 1.0 做了大幅度地修改和完善。 -3-目 录1 JavaScript 命名规范 _41.1 概要命名规范 _41.2 数据类型命名约定：（数据类型加前缀） _42 JavaScript 注释规范 _52.1 单行注释 _52.2 多行注释 _52.3 对哪些内容进行注释 _52.4 注释的参考比例 _63 JavaSc
2、ript 书写规范 _63.1 变量声明 _63.2 换行 _63.3 缩进 _64 JavaScript 与 Html 的结合 _64.1 JavaScript 的封装 _64.2 在 JavaScript 中的注释 _74.3 在 Html 中的相应注释 _75 关于 Jsp 文件命名的建议 _75.1 文件名命名规定 _76 关于页面中各个按钮命名的建议 _11 -4-S3 项目 JavaScript 编码规范1 JavaScript 命名规范1.1 概要命名规范程序元素命名示例；（1） 函数名每个单词的首字母均大写，其他字母小写。如 OpenWindow()。（2） 变量名首字母小写，
3、其他单词的首字母均大写，其他字母小写。如 strFileName.（3） 常量名全部字符大写。如 PI.1.2 数据类型命名约定：（数据类型加前缀）数据类型 前缀 例子字符型 string Str strPathAddress数值型 I iAge布尔型 Boolean Bl blPass对象类型 O oText数组类型 A aName注意：上表中未列出的类型，请参见 S3 项目 Java 编程规范 。另有 Null、 Undefined ,只有单值数据。注意：JavaScript 本身对变量命名约束如下： 第一个字符必须是一个 ASCII 字母（大小写均可） ，或一个下划线 (_)。注意第一个
4、字符不能是数字。 后续的字符必须是字母、数字或下划线。 变量名称一定不能是保留字 -5-2JavaScript 注释规范2.1 单行注释 单行的 JavaScript 注释以一对正斜杠(/)开始。下面给出一个单行注释的示例。/ 这是一个单行注释strGoodIdea = Comment your code thoroughly.; 注：单行注释一般只对较短的代码注释,并且注释要写在被注释的代码的正上面。2.2 多行注释多行注释以一个正斜杠加一个星号的组合 (/*) 开始,并以其逆向顺序 (*/) 结束。/*这是一个用来解释前面的代码语句的多行注释。该语句将一个值赋给 strGoodIdea 变
5、量。*/注意(1) 如果您试图将一个多行注释插入到另一个注释中，JavaScript 不能按正常的方式解释生成的多行注释。标明嵌入的多行注释结束的 */ 被认为是整个多行注释的结尾。这就意味着嵌入多行注释之后的文本不再被认为是注释；相应地，它将被解释为 JavaScript 代码，并会产生语法错误。(2) 多行代码注释一般是对过程和函数的注释。并且注释要写在被注释的代码的正上面。2.3 对哪些内容进行注释 各种变量：注释其功能； 各种函数：注释其功能、参数、返回值、异常等； 程序段：注释其功能； 程序文件：注释其功能、版本、参数、作者、最后更新日期等内容。 -6-2.4 注释的参考比例注释的总
6、行数一般不少于被注释程序代码行数的 20%。3JavaScript 书写规范3.1 变量声明尽可能消除公共变量的声明，变量名尽可能反映其逻辑含义。3.2 换行一行只写一句代码，以分号（；）结束，不建议一行写多条语句。大括号要独站一行。如：String strName=”Tom”;.3.3 缩进按照程序处理的层次关系逐级缩进。 缩进符：Tab键 不许用空格键缩进。4JavaScript 与 Html 的结合4.1JavaScript 的封装对 JavaScript 代码要尽可能的封装，以提高代码的复用率。通过在 Html 里触发事件和 JavaScript 之间传递参数尽可能的达到对公用代码的封
7、装，提高可重用性和灵活性。在 Html 中通过标签引入 JavaScript.。如： -7-4.2 在 JavaScript 中的注释要加注释指明该过程（函数）的作用；如果 JavaScript 过程（函数）有形参则必须在过程前加注释指明参数代表的意思。如： /* 打开窗口事件，参数 strFileName 代表要打开的窗口中显示的文件的名字，strWindowSize 代表窗口的高度 */function OpenWindow(strFileName, strWindowHeight)4.3 在 Html 中的相应注释在带触发事件的 Html 代码的正上面的一行加注释，说明触发事件的作用，传
8、递的值的具体含义等信息。如：5 关于 Jsp 文件命名的建议5.1 文件名命名规定一. 文件名要以英文命名，而且每个单词首字母要大写。如添加学校基本信息的页面，其文件名为：SchoolBasicInfo_Add.jsp -8-二. 文件名要以下划线分段。如 Student_Add.jsp三. 具体的操作页面的命名参考如下：1. 增加记录页入口 增加 记录的页面 为：文件名 “*_Add.jsp”， 如：增加学校基本信息的页面，其添加记录文件名为：SchoolBasicInfo_Add.jsp 。2. 单增 记录的页面 单增记录的页面为：文件名 “*_SinAdd.jsp”。 保存单增记录的页面
9、为：文件名 “*_SinAdd_Save.jsp”。3. 群增 记录的页面 群增记录的页面为：文件名 “*_MulAdd.jsp”。 保存群增记录的页面为：文件名 “*_MulAdd_Save.jsp”。4. 连增 记录的页面 连增记录的页面为：文件名 “*_ConAdd.jsp”， 如：连增学校基本信息的页面，其添加记录文件名为：SchoolBasicInfo_ConAdd.jsp 。 保存连增记录的页面为：文件名 “*_ConAdd_Save.jsp”， 如：保存连增的学校基本信息的页面，其保存记录文件名为：SchoolBasicInfo_ConAdd_Save.jsp 。5. 修改 记录
10、页 入口 修改记录的页面为：文件名 “*_Upd.jsp”， 如：修改学校基本信息的页面，其修改记录文件名为：SchoolBasicInfo_Upd.jsp6. 单改 记录页 单改记录的页面为：文件名 “*_SinUpd.jsp”。 保存单改记录的页面为：文件名 “*_SinUpd_Save.jsp”。7. 群改 记录页 群改记录的页面为：文件名 “*_MulUpd.jsp”。 保存群改记录的页面为：文件名 “*_MulUpd_Save.jsp”。8. 删除 记录页 入口 -9-如果要向数据库中删除记录必须有删除页等，现对删除记录操作所涉及的文件命名问题建议如下： 删除记录的页面为：文件名 “
11、*_Del.jsp”， 如：删除学校基本信息的页面，其删除记录文件名为：SchoolBasicInfo_Del.jsp9. 单删 记录页 单删记录的页面为：文件名 “*_SinDel.jsp”。 保存单删记录的页面为：文件名 “*_SinDel_Save.jsp”。 单删记录的提示页面为：文件名 “*_SinDel_Tip.jsp”。10. 群删 记录页 群删记录的页面为：文件名 “*_MulDel.jsp”。 保存群删记录的页面为：文件名 “*_MulDel_Save.jsp”。 群删记录的提示页面为：文件名 “*_MulDel_Tip.jsp”。11. 维护 记录页 入口 维护记录的页面为：文件名 “*_Maint.jsp”。如，维护学校基本信息的页面，其文件名为：SchoolBasicInfo_Maint.jsp 。12.查询记录页入口如果要从数据库中查询记录必须有查询显示页等，现对查询记录操作所涉及的文件命名问题建议如下： 浏览记录的页面为：文件名 “*_Que.jsp”， 如：浏览学校基本信息的页面，其查询记录文件名为：SchoolBasicInfo_ Que.jsp 。 设置查询条件的页面为：文件名 “*
