WEB前端编码规范.doc

1、XXXX 有限公司XXXXXXXX 管理平台Web 前端代码编写规范文件标识：当前版本： 1.0作 者： 李光强文件状态： 草稿 正式发布 正在修改 完成日期： 2016.1.30XXXXXX2016 年 1 月修改历史编号 修订后版本号 修订人 修订内容简述 修订日期1 1.0 李光强 起草 2016.1.30第一部分 HTML 规范HTML 并不是一种编程语言，而是一种标记语言，它没有任何真正的编程语言中的循环或是流程控制语句。然而，HTML 代码的格式和风格是非常重要的，因为要经常对 HTML 代码进行维护和修改，因此 HTML 代码必须有很清晰的逻辑结构和布局，而使其易懂和易于维护。H

2、TML 语言是不区分大小写的，但为改善可读性，规定小写所有字母（除最上一行引用外）。与 HTML 不一样， XHTML 对大小写是敏感的，和是不同的标签。具体规范如下：1.文件定义2.网站 head 区代码规范：head 区是指和之间的内容。必须加入的标签：2.1 公司版权注释2.2 网页显示字符集简体中文：繁体中文：英 语：2.3 作者与版权信息此处用于存储开发公司版权信息，如：2.4 网页的 css,javascript 规范在引用 CSS 和 JS 文件时，统一放置在 中，先放 CSS 引用，再放 js 引用。html 中 javascript 的书写：2.5 网页标题Title 中使用

3、“-”分割，如：设备管理平台-运维系统。2.6 设置搜索关键词百度关键词搜索指数：http:/ AdWords 关键字工具：查询特定关键词的常见查询及扩展匹配。KEYWRODS 关键字最多不超过 5 个建议长度：小于等于 100 个汉字，如果使用的网页编码是 UTF-8，不同关键字之间用英文 “,”分隔。2.7 网站简介description 是描述网页内容的，因此最好是可以用一句话来概括本网页的主题内容。description 不要超过 255 个字符，搜索引擎索引一般都会索引Description 的前 255 个字符，因此，这 255 个字符是做搜索引擎优化的关键。如果使用的网页编码是

4、UTF-8，那么在 Description 中的标点符号最好都使用英文，例如英文的逗号、句号等。如果是中文的话，那么就使用中文的标点符号即可。2.8 其它标签非必需1.设定网页的到期时间。一旦网页过期，必须到服务器上重新调阅，这样有利于页面信息。2.禁止浏览器从本地机的缓存中调阅页面内容。3.用来防止别人在框架里调用你的页面。4.自动跳转。5 指时间停留 5 秒。5.网页搜索机器人向导.用来告诉搜索机器人哪些页面需要索引，哪些页面不需要索引。CONTENT 的参数有 all,none,index,noindex,follow,nofollow。默认是all。6.收藏夹图标图片大小 16px*1

5、6px7.订阅 RSS 浏览是一种描述和同步网站内容的格式。用户可以通过 RSS 阅读器订阅。2.9 完整示例3. html 中元素的书写：区域标签3.1 段落段落使用 标签进行定义。This is a paragraph3.2 标题即正文标题一般用标签，最好和 title 标签的内容有关联。标题使用 至 标签进行定义。 定义最大的标题。 定义最小的标题。This is a headingThis is a headingThis is a headingThis is a headingThis is a headingThis is a heading文章中的小标题一定也要加粗。可以把网页

6、中的重要内容做成这样。用户不用登陆这个网页就可看到更新的内容。3.3 字体的设置标签 换行：字体修饰不要使用等进行标注，一般使用 css 样式进行字体样式排版3.4 注意事项1.为了保证浏览器的兼容性，必须设置页面背景：2.关闭所有的标签打开的标签必须关闭，例如，当然还有一种关闭方式，如：。即：一定要有结束标记。3. 属性值用双引号 “” 括起来,属性统一使用小写例如：4. 给所有的属性赋值不正确的写法：正确的写法为：5.标签要合理嵌套不正确的写法： 正确的写法为：7.特殊字符用编码标识如 “ “ 用 “表示。8.网页中图片优化一定要加 alt 属性，alt 属性指定了当图片不能显示的时候就显

7、示供替换文本。 内容最好与关键词相关。如：一些小图标最好用.png 或.gif 格式图片，比如说箭头，文章列表前的图标等，在 CSS 中做成背景。这些小图标最好做一张图片，用 CSS 来定位。9.用结构化的元素输出内容新现代新现代新现代或者使用10标签要有缩进，便于代码阅读修改。11、 tr、td 必须定义在 table 之间；.注：tbody 绝对不可以省略。12、 button 按钮必须定义在 form 之间，否则 netscape 不支持；13、html 注释(1) 每一独立部分都要表明注释。例如：块代码的注释大量代码块，使用此种样式，方便阅读(2) 注释要用描述性语言，能够清楚的表达每

8、一部分的意思。4. HTML 元素的排序规则能够使用的 HTML 元素包括：div、p、ul、table、span、input、select等。基本上 div、table、ul、 p 都属于结构性比较强的元素，而 span、input则是比较弱的元素，因此不允许有 span 嵌套 div、table 等等的情况出现，span 可以嵌套 input, 可以嵌套 span。在写页面的时候可以先不考虑界面呈现，按照这样的规则，把数据直接绑定到 HTML 元素的节点上。 5.九大原则原则一：一般要写兼容多种浏览器的网页，最省事的方法就先写适合 chrome 的样式，并在 chrome 进行调度。测试时

9、可以使用多种浏览器。原则二：逐步叠加的方式，如果需要用这个样式的模块很多，并且会存在些许的不同，千万不要把样式一步写到位，最好把框架性的先写好，细节性的留到第二个步骤，甚至第三个步骤，当然最好步骤不要超过三步，这样很不利于维护。由若干个二级定义对一级定义进行补充，这样的既可以减少代码，又可以减少繁多的 CLASS 命名。不要轻易修改共用的 CSS，否则可能会影响其它页面。在每个一级 CSS 前添加注释，说明哪些页面使用了该 CSS。原则三：从总到分。顺序应该是这样：总体需要用到的结构模块二级模块细节；并且这个文档最不容易修改的处于最上端，频繁用于修改的在末端。最忌讳即兴发挥，这样写出的东西经不

10、起推敲，稍有变化就要忙得乱成一团。结构性的东西应该慎重精细。原则四：尽量把能够放在一组的小图标或者图片放在一个图片文件里，这样的好处有很多。1、 图片文件的总量会变小；2、利于下载，太多的小图片下载效果是不理想的，常常会发现这个图片出来，那个没出来，这样在写样式的时候只需要写一个总体的，对于具体的要显示的只需要标一个位置，非常省时间，样式也很精炼；3、 显而易见，这样做非常便于管理，替换或新增的时候工作量很小。原则五：切图的原则，应该切大的图绝不切小，应该切小的绝不切大，能够用颜色代替的绝不切图。把一个大图切成很多份并不一定能够加快页面的显示速度，相反会浪费很多不必要的带宽。不光要控制图片文件

11、的多少，还要考虑到这样切会不会造成页面增加许多额外的代码。原则六：图片使用能名称表达图片意义的名词命名，尽量不要使用编号命名。原则七：涉及多行多列的特别是列宽有不固定的，坚决用表格，千万不要为了 DIV而 DIV。多个图片规则排列时，可以使用。原则八：尽可能不把样式直接写到元素的标签里（ 除非这个样式出现的几率特别小，有相当程度的偶然性 ）。原则九：尽量不要用 ID 来定义或索引样式，ID 的唯一性比较高，且用 ID 索引样式效率非常低而且兼容性的问题也比较明显。6文件命名原则6.1 前台文件组织在前台页面文件中，每个大类功能模块（子系统）单独创建一个文件夹，使用与之相关的有意义的英文名词命名

12、。例如有一个系统包括后台管理（admin）、前台商城（shop）、会员中心（ member）和商家中心（store）等子系统，文件夹组织：每个子系统中应该包含一个缺省的 html 文件，文件名统一用index.html，即当用户缺省访问该目录时，自动加载该页面。公用页面（如登录 login.html、页头 header.html、页脚 footer.html、导航 navigation.html、菜单 menu.html、信息/错误提示 message.html 等），可以统一放在 common 目录中。6.2 页面命名规则具有管理功能的页面，如用名、角色、设备、日志、文章等的管理，可以归纳为

13、列表（list.htm）、新建（ add.html）、编辑（edit.html）等几类操作，所以在页面组织时，每类模块单独创建一个文件夹，使用能够表达模块意义的英文名词命名，并在其中分别创建 list.html、add.html、edit.html 等文件，对应于内容列表、添加、编辑等操作。示例：其它说明：1. 在列表页面里统一使用“四栏式”显示风格，即列表页面里必须包括模块目录/位置提示、工具栏（含添加、编辑、删除、刷新、查询等操作控件）、表格、分页操作等部分。示例：2. 表格用于显示查询内容，在 list.html 打开时，必须默认加载一定的记录；表格栏目仅显示用户常用或关心的字段；在显示

14、时必须对表格内容进行必要的格式处理；对记录常用的操作可以放置于操作栏内（如上图中的操作栏内放置有编辑和删除两个操作按钮）。3. 表格可以统一使用 easyui datagrid 或 bootstap data tables。6.3. 资源文件的命名原则资源文件包括 css、js、图片等内容。所有资源文件统一存储在 web 根目录 resource 文件夹中。示例：每个子系统（大类）文件夹命名规则同 6.1 规则。每个子系统文件夹中分别包括 css、js 和 images，示例：多个子系统公共使用的资源，统一存储在 common 文件夹中，如常用的 js操作，可以命名为 generic.js，放

15、置在 common/js/generic.js。6.3 图片命名规则图片分成两部分，一是网页设计时使用的静态资源，通常不会因系统的运行而发生变化，另一类是程序生成、用户上传、终端上传的图片。（1）静态图片存储在 resources大类目录images 中，使用能表达图片意义的英文单词命名，不能使用图片编号命名。网面使用的小图标，可以放置在一个图片文件中，使用 css 裁切和背景方式显示在页面中。（2）动态图片存储在 resourcesupload 目录中，在其中创建分类图片目录。例如，与系统相关的图片存储在 system 目录中，设备监控相关图片存储在management 中等。为了避免同一文

16、件夹中文件数量限制，在分类目录中，按上传日期分成不同的次级目录，命名规则为上传文件所在的 yyyyMM（年度月份），其中月份使用两位数字表示。例如： 上传的图片统一使用 GUID 标识进行命名，即在上传时，由接收的 java 程序自动生成 guid 编号+.图片扩展名进行命名。注意：保存图片时，文件扩展名必须保持不变。示例：7.常用 HTML 标识符HTML 标记一览:标记 类型 译名或意义 作 用 备注文件标记 文件声明 让浏览器知道这是 HTML 文件 开头 提供文件整体资讯 标题 定义文件标题，将显示于浏览顶端 本文 设计文件格式及内文所在 排版标记 说明标记 为文件加上说明，但不被显示

17、 段落标记 为字、画、表格等之间留一空白行 换行标记 令字、画、表格等显示于下一行 水平线 插入一条水平线 居中 令字、画、表格等显示于中间 反对 预设格式 令文件按照原始码的排列方式显示 区隔标记 设定字、画、表格等的摆放位置 不折行 令文字不因太长而绕行 建议折行 预设折行部位 字体标记 加重语气 产生字体加粗 BOLD 的效果 粗体标记 产生字体加粗的效果 强调标记 字体出现斜体效果 斜体标记 字体出现斜体效果 打字字体 COURIER 字体，字母宽度相同 加上底线 加上底线 反对 一级标题标记 变粗变大加宽，程度与级数反比 二级标题标记 将字体变粗变大加宽 三级标题标记 将字体变粗变大

18、加宽 四级标题标记 将字体变粗变大加宽 五级标题标记 将字体变粗变大加宽 六级标题标记 将字体变粗变大加宽 字形标记 设定字形、大小、颜色 反对 基准字形标记 设定所有字形、大小、颜色 反对 字体加大 令字体稍为加大 字体缩细 令字体稍为缩细 画线删除 为字体加一删除线 反对 程式码 字体稍为加宽如 键盘字 字体稍为加宽，单一空白 范例 字体稍为加宽如 变数 斜体效果 传记引述 斜体效果 引述文字区块 缩排字体 述语定义 斜体效果 地址标记 斜体效果 下标字 下标字 上标字 指数（平方、立方等） 清单标记 顺序清单 清单项目将以数字、字母顺序排列 无序清单 清单项目将以圆点排列 清单项目 每一

19、标记标示一项清单项目 选单清单 清单项目将以圆点排列，如 反对 目录清单 清单项目将以圆点排列，如 反对 定义清单 清单分两层出现 定义条目 标示该项定义的标题 定义内容 标示定义内容 表格标记 表格标记 设定该表格的各项参数 表格标题 做成一打通列以填入表格标题 表格列 设定该表格的列 表格栏 设定该表格的栏 表格标头 相等于，但其内之字体会变粗 表单标记 表单标记 决定单一表单的运作模式 文字区块 提供文字方盒以输入较大量文字 输入标记 决定输入形式 选择标记 建立 POP-UP 卷动清单 选项 每一标记标示一个选项 图形标记 图形标记 用以插入图形及设定图形属性 连结标记 连结标记 加入

20、连结 基准标记 可将相对 URL 转绝对及指定连结目标 框架标记 框架设定 设定框架 框窗设定 设定框窗 页内框架 于网页中间插入框架 IE 不支援框架 设定当浏览器不支援框架时的提示 影像地图 影像地图名称 设定影像地图名称 连结区域 设定各连结区域 多媒体 背景声音 于背景播放声音或音乐 IE 多媒体 加入声音、音乐或影像 其他标记 走动文字 令文字左右走动 IE 闪烁文字 闪烁文字 NC 页内寻找器 可输入关键字寻找于该一页 反对 开头定义 让浏览器知道这是 HTML 文件 关系定义 定义该文件与其他 URL 的关系 STYLESHEET 样式表 控制网页版面 自订标记 独立使用或与样式

21、表同用 注： 表示该标记属围堵标记，即需要关闭标记如 。 表示该标记属空标记，即不需要关闭标记。 IE 表示该标记只适用于 INTERNET EXPLORER。 NC 表示该标记只适用于 NETSCAPE COMMUNICATOR。 反对 表示该标记不为 W3C 所赞同，通常这标记是 IE 或 NC 自订，且己为众所支 持，只是 HTML 标准中有其它同功能或更好的选择。 弃用 表示该标记己为 W3C 所弃用，是过时的标记，但 HTML 具向下兼容的特 性，不用担心新浏览器不支援旧标记。第二部分 CSS 编码规范1. 基本书写规范 1.1 所有的 CSS 的尽量采用外部调用书写时重定义的最先，

22、伪类其次，自定义最后（其中 a:link a:visited a:hover a:actived 要按照顺序写）便于自己和他人阅读。 为了保证不同浏览器上字号保持一致，字号建议用点数 pt 和像素 px 来定义，pt 一般使用中文宋体的 9pt 和 11pt，px 一般使用中文宋体 12px 和14.7px 这是经过优化的字号，黑体字或者宋体字加粗时，一般选用 11px 和14.7px 的字号比较合适。字体选择：优先使用微软雅黑，其次为宋体，可以统一在 body 中定义，而自定义样式中，不需要重复定义字体。如：1.2 CSS 推荐模板 body font-size:9pt; font-fami

23、ly:Arial, Helvetica, sans-serif; color:#333333; text-align:center; margin:0px;ul margin:auto; img border:0px; a font-size:9pt; text-decoration:none;color:#FFFFFF; a:hover font-size:9pt; text-decoration:underline; color:#990000; a.1 font-size: 9pt; color: #3366cc; text-decoration: none a.1:hover font

24、-size: 9pt; color: #FF9900; text-decoration: none.colorblue,colorblue:hover color:#003366 ;.blue font-family: “宋体“; font-size: 9pt; line-height: 20px; color: #0099FF; letter-spacing: 5em.colorRed,a.colorRed:hover color: #FF0000; .colorLime,a.colorLime:hover color: #00FF00; .colorGreen,a.colorGreen:h

25、over color: #008000; .colorBlue,a.colorBlue:hover color: #0000FF; .colorOrange,a.colorOrange:hover color: #FFA500; 为了保证浏览器的兼容性，必须设置页面背景1.3 CSS 注释写法在定义的 CSS 文件顶部添加文件说明、作者、时间等说明，如例：一级 CSS 上面必须加上注释，说明样式的用处。必要时可以添加作者、创建时间、修改人、修改时间。示例：2.CSS 命名参考CSS 文件名统一使用小写英文单词命名。样式定义变量统一使用 class 命名方式，不建议使用 id 命名方式。如下图中

26、，使用“.”定义的样式为 class 命名方式，使用“#”引导的样式为 id 命名方式。Id 命名方式仅针对于 html 中使用 id 定义的元素，通常复用性较差。2.1 常用的 CSS 命名规则： 头：header内容：content/container尾：footer导航：nav侧栏：sidebar容 器：container/box主 导 航：mainNav子 导 航：subNav顶 导 航：topNav网站标志：logo大 广 告：banner页面中部：mainBody菜 单：menu菜单内容：menuContent子 菜 单：subMenu子菜单内容：subMenuContent搜 索

27、：search搜索关键字：keyword搜索范围：range标签文字：tagTitle标签内容：tagContent当前标签：tagCurrent/currentTag标 题：title列 表：list当前位置：currentPath图 标：icon注 释：note登 录：login注 册：register栏目：column列 定 义：column_1of3 (三列中的第一列)column_2of3 (三列中的第二列)column_3of3 (三列中的第三列)2.2 直观命名当在设计 Web 页面以及需要对一个 div 进行标识的时候，最自然的想法就是使用可以描述元素所在页面位置的词汇来对其命

28、名。如：自上而下分组：top-panel横向导航：horizontal-nav左面边栏：left-side中心-栏目：center-column右面：right-col2.3 CSS 复用不需要重复定义可继承的值，子元素自动继承父元素的属性值，象颜色、字体等，已经在父元素中定义过的，在子元素中可以直接继承，不需要重复定义，除非是为了更变当前元素样式不使用父元素的属性值，但是要注意，浏览器可能用一些默认值覆盖你的定义。2.4.多重 CSS 样式定义CSS 属性追加重复最后优先原则，即一个标签可以同时定义多个 class，也可以是同一个 class 中重复定义属性。例如：先定义两个样式.onewi

29、dth:200px;background:url(http:/ no-repeat left top;.twoborder:10px solid #000; background:url(http:/ no-repeat left top;在页面代码中，我们可以这样调用:当应用两个或多个样式时，浏览器所应用的样式根据是属性追加重复最后优先原则。即两个或多个或重复的样式名定义，浏览器所应用的样式是按先后顺序的，如果定义了重复的属性值，以最后定义的为准，如果应用了两个或多个样式名，里面不重复定义的属性值就追加上去，重复的属性值就以最后一个为准。这里要注意的是，样式的先后不是根据页面上应用的名字顺序

30、，而是样式表里的样式顺序。2.5.CSS 作用域CSS 的作用域是通过书写方式来实现的更准确的说法应该叫做选择器如果你深入了解后，同样能达到编程思想中的“命名空间”、“全局”、“私有”、“继承”等“编程特性”更能体现他特点的也就是他名字中的“层叠样式”。如下面的 p 的作用域：/*作用域：全局*/ ptext-indent:2em;/*作用域：.demo 这个类中*/ .demo pcolor:#000000;3. CSS 样式书写顺序3.1 显示属性* display * list-style * position * float * clear 3.2 自身属性 * width * hei

31、ght * margin * padding * border * background 3.3 文本属性 * color * font * text-decoration * text-align * vertical-align * white-space * other text * content 4.其它规范4.1 图片样式禁止用 来人为干预图片显示的尺寸，即在 HTML代码中的 标签中不要带上 width 和 height 两个属性，因为制作过程中，图片往往需要反复的修改。但是使用 CSS 控制图片大小时，当网页还未加载图片时，不会留出图片的占位大小，可能会造成网页在加载过程中抖动

32、（如果图片是插在一个固定大小的表格里的，不会有这个现象），尤其是当图片的尺寸较大时，这种现象会很明显。所以当预料到这种会明显导致网页抖动的情况会发生时，务必给 附上 width 和 height 属性。4.2 换行为了最大程度的发挥浏览器自动排版的功能，在一段完整的文字中请尽量不要使用 来人工干预分段。4.3 字体所有的字号都应该用样式表来实现，禁止在页面中出现 标记。请不要在网页中连续出现多于一个的也尽量少使用全角空格（英文字符集下，全角空格会变成乱码），空白应该尽量使用 text-indent, padding, margin, hspace, vspace 以及透明的 gif 图片来实现

33、。中英文混排时，我们尽可能的将英文和数字定义为 verdana 和 arial 两种字体。行距建议用百分比来定义，常用的两个行距的值是 line-height:120%/150%.第三部分 JavaScript 规范1.命名规范1.1 基本原则规范的命名能使程序更易阅读，从而更易于理解。它们也可以提供一些标识功能方面的信息，有助于更好的理解代码和应用。 使用可以准确说明变量/函数/原型(prototype)的完整英文描述符。例如， firstName，listAllUsers 或 CorporateCustomer 等，避免使用汉语拼音、不相关单词及汉字进行命名。 采用大小写混合，提高名字的可

34、读性。一般应该采用小写字母，但是原型(prototype)命名时任意单词的首字母大写。 尽量少用缩写，但如果一定要使用，当使用公共缩写和习惯缩写等，如实现（implement）可缩写成 impl，经理（manager）可缩写成mgr 等，严禁滥用缩写。 避免使用长名字（最好不超过 25 个字母） 。 避免使用相似或者仅在大小写上有区别的名字。 避免使用数字，但可用 2 代替 to，用 4 代替 for 等，如：go2Jsp。此外，若元素 id 包含数字则除外1.2 Prototype/Method 命名规范1.2.1 原型 Prototype所有单词首字母大写。使用能确切反应该原型含义、功能等

35、的词。一般采用名词。1.2.2 方法 Method/函数 Function方法的命名应采用完整的、能够清楚表达该方法功能的英文描述符，首字母小写，其他单词的首字母大写。方法名称的第一个单词常常采用一个有强烈动作色彩的动词。取值类使用 get 前缀，设值类使用 set 前缀，判断类使用 is(has)前缀。如下例所示：getName()setSarry()isLogon()方法参数建议顺序：(被操作者，操作内容，操作标志，其他)。如下例所示：function replace (sourceStr, /源字串oldStr, /被替换字串newStr) /替换为字串1.3 字段命名规范1.3.1 常

36、量采用完整的英文大写单词，在词与词之间用下划线连接，如：DEFAULT_VALUE 1.3.2 变量除第一个单词外其余单词首字母大写。 对私有实例变量可使用_前缀，但在其存取方法中则应该将其前缀去掉。1.3.3 集合 一个集合，例如数组或 xml 节点集合，应采用复数命名来表示变量中存放的是一组对象。命名应采用完整的英文描述符，名字中所有非首单词的第一个字母应大写，适当使用集合缩写前缀。如下例所示：集合变量命名示例var rowNodes = xmlDom.selectNodes(“/*/data/row”); var aryUsers = ; /用户列表 1.3.4 特殊值 我们在程序里经常

37、会用到一些量，它是有特定的含义的。例如，现在我们写一个薪金统计程序，公司员工有 50 人，我们在程序里就会用 50 这个数去进行各种各样的运算。在这里，50 就是“特殊值” 。当别的程序员在程序里看到50 这个数，将很难知道它的含义，造成理解上的困难。在程序里出现“特殊值”会降低程序的可读性、可维护性和可扩展性，故规定不得出现此类“特殊值” 。避免的方法是把“特殊值”定义为一个常量。注意这个常量的命名应该能表达该数的意义，并且应该全部大写，且单词之间使用下划线。例如上面 50 这个数，我们可以定义一个名为 NUM_OF_EMPLOYEES 的常量。这样，别的程序员在读程序的时候就可以很容易的理

38、解了。1.4 异常必要时，在 javascript 代码段中加入异常捕获代码。通常情况下不需要自定义异常原型，仅使用内建 error 对象。异常原型由表示该异常类型的单词和 Exception 组成，如ResponseException。异常实例一般使用 e、ex 等，在多个异常时使用该异常名或简写加 E，Ex等组成，例如：SQLEx、ActionEx。1.5 文件命名规范外部 js 文件一律小写命名。1.6 命名约定表操作项 命名约定 示例参数 使用传递值/对象的完整的英文描述符。 userID 字段/属性 字段采用完整的英文描述，第一个字母小写，任何中间单词的首字母大写。 firstNam

39、e 布尔型的获取成 所有的布尔型获取函数必须用单词 isString() 员函数 is（has）做前缀。 hasMoney() 原型 采用完整的英文描述符，所有单词的第一个字母大写。 Customer 异常原型名 由表示该异常类型等的单词和Exception组成 SQLException ActionException 异常实例名通常采用字母 e 、ex 表示异常。多个异常时使用异常名或其简写加E、Ex等构成 e SQLEx 静态常量字段（常量） 全部采用大写字母，单词之间用下划线分隔。采用静态常量获取成员函数。 DEFAULT_NAME 局部变量 采用完整的英文描述符，第一个字母小写，但不要

40、隐藏已有字段。例如，如果有一个字段叫 firstName，不要让一个局部变量叫 firstName。 ,totalMoney 循环计数器 通常采用字母 i，j，k 或者 counter，index i,j,k,count,index 成员函数 采用完整的英文描述说明成员函数功能，第一个单词尽可能采用一个生动的动词，除第一个单词外，每个单词第一个字母小写。 openFile() addUser() 获取成员函数 被访问字段名的前面加上前缀 get。 getUserName() 设置成员函数 被访问字段名的前面加上前缀 set。 setUserName () 2. 代码组织与风格代码组织和风格的基本原则是：利于个人开发，便于相互交流。因个人习惯和编辑器等可以设置而形成自己独特的风格，但必须前后一致，并符合本规范的基本要求和原则。本章所涉及到的内容一般都可在 editplus 工具编辑环境中进行相应设置。2.1 整体风格整体风格可以参考 Java 篇代码组织与结构的整体风格章节。