WEB开发编程规范.doc

WEB 开发编程规范开发编程规范 界面及编程界面及编程 WEB 开发编程规范 1 前言 1 术语解释 1 范围界定 2 相关开发环境 建议环境 不做强制要求 2 开发工具 2 数据库 3 WEB服务器 仅做开发测试用 3 应用服务器 3 界面开发规范 3 基本要求 3 其它注意事项 6 编程规范 7 基本要求 7 可读性要求 7 正确性与容错性要求 8 可重用性要求 8 变量命名 8 常量命名 8 函数命名 8 注释 8 程序 10 WEB 开发编程规范 前言前言 J2EE 是一种功能完备 稳定可靠 安全快速的企业级计算平台 它由多种基于 JAVA 的技术组成 Enterprise JavaBeans EJB JavaServer Pages JSP servlets Java Naming and Directory Interface JNDI and the JDBC data access API 等 本规范针对从事资源管理开发中前端 WEB 站点开发设计人员 要求使用者对 J2EE 架 构有所了解 具有一定的 HTML CSS 基础知识 对交互式网页 JSP 及 javabeans 的开发 有较深认识 本规范的目的是为了开发出通用的 易于维护的高效率的 J2EE 应用 术语解释术语解释 表示层 即系统与系统使用者通过各终端进行交互时对数据内容的表现层 同时负责 输入数据的格式合法性校验 该层次根据用户的需要完全个性化 应用表示逻辑层 根据个体应用系统的约束条件 实现表示层数据的组织和包装 根 据应用逻辑对表示层输入的数据进行逻辑合法性检验 应用逻辑组件层 实现特定于个体系统的应用逻辑和算法 EJB 持久存储层 可以实现所有实体数据的数据库集中存储 通过该层对持久存储的 CRUD create read update font size 12px color 000000 p text indent 2em text align justify a link color FFFFFF text decoration none a visited color 99FFFF text decoration none a active color FF9900 text decoration underline a hover color FF9900 text decoration underline 1 CSS 定义的顺序为 重定义的最先 伪类其次 自定义最后 以便于他人阅读 对 于伪类 CSS 定义 请严格按照以上顺序格式 即 a hover 放在最后 以便使其不会被其他 定义覆盖 2 为了保证不同浏览器上字号保持一致 字号用点数 pt 和像素 px 来定义 使 用 pt 单位时一般使用中文宋体的 9pt 和 10 5pt 使用 px 单位时一般使用中文宋体 12px 和 14 8px 字体需要作为标题显示时 一般选用 10 5pt 或 14 8px 的字号比较合适 所有的 字号都应该用样式表来实现 禁止在页面中出现 标记 3 排版中我们经常会遇到需要进行首行缩进的处理 不要使用 或者全角空格 来达到效果 规范的做法是在样式表中定义 p text indent 2em 然后给每一段加上 标记 脚本编写脚本编写 1 尽量直接采用 DW MX 提供的 JavaScript 函数库 因为它提供了尖端的客户机方 交互性 而不必学习冗长的教科书 这样也可以保证我们页面中 JavaScript 写法的一致性 所有 javascrips 的客户端脚本必须放在 JSP 页面的标签之前 便于使用模板进行站点 统一管理时不致影响到脚本 2 网页中客户端代码只允许使用 JAVASCRIPS 脚本 禁止用 VBSCRIPTS 网站管理网站管理 1 进入实际开发阶段将设置一测试用主服务器 上开设虚拟 WWW 目录 2 主服务器包含站点完整结构 大家通过 FTP 功能及时上传最新的文件 保持共享 最新的文件 3 实现服务器程序的互斥性修改 要求实现某一程序在同一时间只能一个开发人员修改 其具体实现方式是 需要修改 程序的开发人员从源文件存放处提出 Chink out 一个程序 这时其他开发人员就不可以 再 Chink out 同一个程序了 只有当第一个开发人员修改测试完成后 将更新版本的代码 做放入 Chink in 操作 其他开发人员才能 Chink out 同一个程序 JSP 页面制作及编程技术要求页面制作及编程技术要求 界面风格需要一致 在程序设计中需要注重模块化 而界面设计中对象化同样非常重要 将界面元素对象 化 比如底部版权信息 导航条等 图片尽可能复用 比如站点标志 搜索按钮等等 下 面提几点细节要求 1 网页适用的屏幕大小 制作网页时 显示器的分辨率设置可以为 800 600 或 1024 768 或通过设置表格百分比方式尽量做成自适应的 2 主要页面要写 3 的 alt 属性 使不能看图的用户也可以读懂页面 4 不使用过长的滚屏 采用分页 5 在主页中尽量少使用滚动条 网页中尽量少出现横向滚动条 6 网页版权信息清晰明了 主页版权信息推荐使用下列格式 Best viewed with IE4 0 Resolution 800 600 Copyright 2002 All right reserved 7 如有特殊情况 必须在 readme txt 文件中说明 8 在查询显示结果过多时 除必须分页显示外 将上一页 下一页的翻页按钮同时放 在列表的上面及最底下 并且设置直接跳转到某页的按钮 其它注意事项其它注意事项 控件的命名 控件的命名 用小写前缀表示类别 frm 表单 cmd 按钮 txt 文本输入框 lab 标签 img 图象 pic lst 列表框 注释注释 用 表格应用 仅针对表格应用 仅针对 JSP 页面开发人员输出动态表格时 页面开发人员输出动态表格时 表格不使用表格边框形式 即不得设置 bordercolordark 和 bordercolorlight 属性 也不 准设置表格边框颜色 而是使用由页面设计师提供的 CSS 中设置的 TD content 属性 此种 方式可兼容 IE5 和 NC6 并且只有这种方式 当浏览时有些单元格中无内容时仍可正常显 示边框线 代码范例如下 单元格内容 界面友好界面友好 系统提供灵活的输入方式以方便用户输入 容错能力强容错能力强 系统充分考虑到用户在操作时可能的错误 并提供相应的纠正措施 例如一份表单正 常提交以后 假如用户利用历史记录后退 回到提交前的状态 这时候修改了提交内容 又再一次提交 那么结果是什么呢 编程规范编程规范 基本要求基本要求 程序结构清析 简单易懂 打算干什么 要简单 直接了当 代码精简 避免垃圾程序 尽量使用标准库函数和公共函数 可读性要求可读性要求 保持注释与代码完全一致 每个源程序文件 都有文件头说明 每个函数 都有函数头说明 主要变量 结构 联合 类或对象 定义或引用时 注释能反映其含义 常量定义有相应说明 处理过程的每个阶段都有相关注释说明 在典型算法前都有注释 利用缩进来显示程序的逻辑结构 缩进量一致并以 Tab 键为单位 注释可以与语句在同一行 也可以在上行 空行和空白字符也是一种特殊注释 一目了然的语句不加注释 注释的作用范围可以为 定义 引用 条件分支以及一段代码 正确性与容错性要求正确性与容错性要求 程序首先是正确 其次是优美 无法证明你的程序没有错误 因此在编写完一段程序后 应先回头检查 改一个错误时可能产生新的错误 因此在修改前首先考虑对其它程序的影响 所有变量在调用前必须被初始化 对所有的用户输入 必须进行合法性检查 尽量采用客户端验证方式 不要比较浮点数的相等 如 10 0 0 1 1 0 不可靠 单元测试也是编程的一部份 提交联调测试的程序必须通过单元测试 可重用性要求可重用性要求 重复使用的完成相对独立功能的算法或代码应抽象为公共控件或类 公共控件或类应考虑 OO 思想 减少外界联系 考虑独立性或封装性 公共控件或类应建立使用模板 变量命名变量命名 命名必须具有一定的实际意义 形式为 xAbcFgh x 由变量类型确定 Abc Fgh 表示连续 意义字符串 如果连续意义字符串仅两个 可都大写 常量命名常量命名 常量定义必须具有一定的实际意义 常量定义必须全部以大写字母来撰写 中间可根据意义的连续性用下划线连接 每一条定 义的右侧必须有一简单的注释 说明其作用 函数命名函数命名 函数原型说明包括引用外来函数及内部函数 外部引用必须在右侧注明函数来源 javabean 的名称或 include 的文件名 如是内部函数 只要注释其定义文件名 第一个字母必须使用大写字母 要求用大小写字母组合规范函数命名 必要时可用下划线 间隔 注释注释 原则上注释要求使用中文 文件开始注释内容包括 公司名称 版权 作者名称 时间 模块用途 背景介绍等 复 杂的算法需要加上流程说明 函数注释包括 输入 输出 函数描述 流程处理 全局变量 调用样例等 复杂的函数 需要加上变量用途说明 程序中注释包括 修改时间和作者 方便理解的注释等 引用一 文件开头的注释模板 文件名 Copyright c 2001 7 2001 9 创建人 日 期 修改人 日 期 描 述 版 本 引用二 函数开头的注释模板 函数名 输 入 a b c a b c 输 出 x x 为 1 表示 x 为 0 表示 功能描述 全局变量 调用模块 作 者 日 期 修 改 日 期 版本 引用三 程序中的注释模板 注释内容 程序程序 程序编码力求简洁 结构清晰 避免太多的分支结构及太过于技巧性的程序 尽量不 采用递归模式 编写程序时 亦必须想好测试的方法 如在 javabean 中包括方法时 在源程序中一般 也应包括类似的代码 当然自行测试无误后必须用 封闭 public static void main String argv MusicCollection m1 new MusicCollection System out println m1