WEB开发规范初稿1.doc

WEB开发规范初稿目 录一 整体页面效果2二 表单类4三 表格类5四 控件外观类6五 代码类8六 SQL类9七 命名类10八 自行测试类11一 整体页面效果1 所有页面都要具有和本页标题相同的title。2 所有中文页面都要加上语言设置语句。3 所有页面要在1024*768 1440*900两种分辨率下运行通过，其中宽屏如客户无特殊要求采用居中方式不变形即可。4 所有页面要在IE6.0以及7.0下运行通过没有脚本程序错误。5 界面设计原则：风格必须统一，界面风格依据美工原始效果图。6 B/S结构开发原则：使用框架。7 页面使用表格（Table）进行格式设置：表格百分比定宽，居中，隐藏边框。8 主页面Body设置：bgcolor=#FFFFFF。9 框架子页面Body设置：bottomMargin=0 leftMargin=0。 10 冒号必须是在中文输入状态下键入。11 控件外观在CSS内设置，主要包括：链接，表格，文本框，数据集。12 一般性项目开发的主框架是三个，其命名规则如下：顶部框架：_topFrame左侧框架：_leftFrame主框架 ：_mainFrame13登录界面完成用户身份和权限识别的功能，要求界面简单明了，美观大方。界面功能键包括登录、取消和重置。若输入密码有问题，需要提示重新输入，提示规范请参考下一节。部分项目提供图形验证码功能。14 整体界面背景颜色设为白色，大部分字体采用黑色。整个WEB程序采用统一的CSS样式表来控制界面风格。15 字体一般情况下中文采用楷体；英文采用Arial。16 字形一般情况下应采用常规字型，仅当特殊需要时才考虑其他字型(如下划线、粗体字、斜体字等)。17 按钮形状统一由CSS样式表控制。18 相同类别的按钮应放在一起，组成按钮组，按钮组之间保持适当的距离，“确定”、“取消”、“退出”等按钮归为一类；“新增”、“修改”、“保存”、“删除”等按钮归为一类；“查询”、“打印”、“下载”等按钮归为一类；“各类按钮按以上列出的顺序从左向右排放，例如第一类中“确定”按钮放在最左边、“退出”按钮放在最右边、“取消”按钮放中间。按钮的排放顺序遵循常用和重要的放左边的原则。19 菜单层次一般采用两层菜单。设计原则是将常用的、需单独处理的功能模块作为主菜单；将可归并为主菜单上的某一项、功能上相近或相关的作为二级菜单。20 滚动条采用自动方式，只在窗口的宽度和长度小于数据显示所需宽度或长度时才滚动条，而且只在主框架和左侧框架中出现，顶部框架不允许出现滚动条。21 界面布局统一为“顶部和左侧的嵌套框架”形式进行界面设计，顶部框架放置LOGO、BANNER和一些公共功能，如返回主页、退出等，左侧框架放置系统菜单和各子菜单，右侧框架作为主显示窗口。每个框架的显示内容都应占据整个页框架的可用部分，不应留下空白。22顶部框架占页面高度的15-20%。23左侧框架占页面宽度的15-18%，呈目录树结构。24 主框架要求：主框架第一行显示当前选择的功能界面名称且尽量按导航方式显示。按钮放在框架的底部中间或右侧。字段排列的优先顺序为从左到右，从上到下。需要用户输入或点选操作的字段应优先排放，并要求按主关键字、索引关键字、其他字段的顺序依次排放，使用频率高的字段排在前面，按TAB键的时候能按次序跳到下一个字段。不允许用户输入或点选的字段应明显表示，采用背景变灰的方式。25 链接路径全部采用相对路径。26用DreamWeaver设计网页的时候，自动产生的代码可能比较乱，可以用“适应源文件格式”来进行整理。27所有的字号都应该用样式表来实现，禁止在页面中出现 标记。28页面，表格都应该有边距，避免紧贴边沿的情况发生，最小边距值为“3px”，默认边距值应在CSS中设定。29 页面内容信息应铺满整个框架页面并适当留白方便阅读，严禁出现大片空白的页面设计。二 表单类1 输入类控件textbox都需要制定maxlength属性 默认值为数据库中对应的字段的长度或该类型字段常规长度。2 所有不可更改的信息都要使用readonly属性。3 所有form都要指定提交前需要的检查程序或对应JS校验代码。4 所有form都要有对应的reset button。5 控件的命名采用控件类型缩写（小写）+英文单词（第一个字母大写）的方法。比如button：btn+英文单词。6 所有控件的属性值都要使用双引号或者单引号包括起来。7所有错误信息全部使用中文提示错误信息，标点使用中文半角符号，格式如下：错误：+提示信息+！ 。8所有成功信息全部使用中文提示成功信息，标点使用中文半角符号，格式如下：成功：+提示信息+！9 所有进行过增、删、改的操作按钮必须给出操作成功或错误的信息提示。10 所有需要有返回的页面须有页面的返回链接，使用链接不用按钮。11 保证提交前的数据都会通过JavaScript进行数据类型以及长度的判断。12 所有涉及删除的操作，在用户选定以后都要再进行一次确认操作后方可执行删除操作。13 通过Get，Post，连接传递过来的数据在使用前都要通过trim去掉数据前后的空格。14 通过request的得到的参数数据需要再次进行空，类型，和长度的判断。15 所有参数传递须进行防SQL注入校验。16 所有错误提示信息使用JavaScript弹出窗提示信息，保证使用者看不到任何内部错误信息。17 控件要求：字段类型为文本、数字时，控件使用文本框字段类型为布尔值时，控件使用单项选择按钮或下拉框字段内容在固定的几个值中选择时（不论其类型），控件使用下拉框字段类型为日期时间时，控件使用文本框+按钮（按钮可以选择日期）字段为其它表的外键且属于基本资料的，控件使用下拉框。字段为其它表的外键且不是属于基本资料的，控件使用文本框+按钮（按钮用于跳出查询窗口）。17若某项操作需要耗费较长的时间，在进行操作前应予以提示，列出可能耗费的时间，以免在后台操作过程中，用户因等待过久而退出或重做。18 耗时较长操作尽量采用等待条且锁定页面方式进行。三 表格类1 表格对齐方式要求：文字(标签)右对齐；数字(数据)右对齐；文字（数据）左对齐,比较短的可以居中对齐；金额左对齐，需加上千位符。2 数据集对齐方式要求：文字（短）居中对齐；文字（长）左对齐；日期左对齐；数字左对齐；金额左对齐，需加上千位符。3 查询要求：查询条件如无特殊说明，不输入表示无限制查询支持组合查询，所有查询条件为逻辑和的关系查询结果如无特殊说明，应遵循按主键或唯一键值的升序排列，支持选择排序方式和排序字段。对用户输入的一些字段，在进行后台操作之前应先进行检查，例如日期查询条件所有的查询条件需在设计文档中标注是按模糊查询还是精确查询。4 表格的宽度尽量依据数据字段的宽度设定。5 详细页面（明细）请尽量使用Label，不要使用类似修改的form页面。6 除非客户要求，数据表格上均支持按某些键值的自定义排序，排序要求需在设计文档中详细描述。7 翻页的条数一般限制在20-25条之间。8 除特殊类数据字典外（比如树形结构、数量很少的字典内容），其余数据集必须使用翻页功能。9 标题属性字段默认为“查看”链接。10 数据列表上的操作按钮，一般应以新开窗体或对话框的形式完成，且新开窗体或对话框必须有“关闭”按钮。四 控件外观类控件类型Control Type宽度(像素)Width(px)高度(像素)Height(px)备注RemarkLabel适应文本适应文本TextBox150px|100%|超短|超宽默认值Button50px|文本宽度默认值LinkButton适应文本适应文本ImageButton适应图片适应图片HyperLink适应文本适应文本DropDownList150px|100%|适应文本默认值ListBox150px|100%|适应文本100px |适应项目数|按需DataGrid按需按需DataList按需按需Repeater按需按需CheckBox适应文本默认值CheckBoxList适应文本适应项目RadioButtonList适应文本适应项目RadioButton适应文本默认值Image适应图片适应图片Panel适应内部控件|按需适应内部控件|按需PlaceHolder适应内部控件|按需适应内部控件|按需Calendar按需按需AdRotator按需按需Table按需按需RequireFieldValidator适应文本默认CompareValidator适应文本默认RangeValidator适应文本默认RegularExpressionValidator适应文本默认CustomValidator适应文本默认ValidationSummary默认默认Xml默认默认Litteral默认默认CrystalReportViewer默认默认五 代码类1 代码外观规范遵循Microsoft Visual Studio 2005开发平台代码规范。2 注释规范遵循Visual Studio 2005 开发平台默认的方式，以便代码完成后直接生成代码文档，让别人更好的了解代码的实现和接口。3 声明规范：一行只作一个声明，并按字母顺序排列，同时在变量声明时就对其做初始化。4 变量建议置于块的开始处，不要总是在第一次使用它们的地方做声明。5 语句规范每行最多包含一个语句。6 注释规范：页面开始时须包括：名称，描述，输入，输出，作者，修改日期，备注。所有变量和常量均要有注释。过程和函数也要有注释，包括：名称，目的，输入，输出，参数，备注。过程或存储过程内部的注释应按功能块分。针对程序中的部分代码片段注释，需注明该段代码的开始和结束部分六 SQL类1 order时应该尽量提前使用建立索引或者主键的字段排序。2 select时避免使用*，即使需要所有字段也应尽量一个一个按照使用的顺序罗列出来。3尽量避免使用in和not in4 SQL关键字采用大写，其他的与数据库保持一致。5 其他常规规范请参阅相关书籍。七 命名类1 文件名遵从Pascal命名法，无特殊情况，扩展名小写。2 命名空间一般性规则是使用公司名称，后跟技术名称和可选的功能与设计。3 类命名不可使用下划线，使用名词或名词短语命名类，同时不要使用类型前缀。4 接口命名同类命名方式，但是接口名称要加上字母 I 前缀，以指示该类型为接口。5 方法命名使用 Pascal 大小写，使用动词或动词短语命名。6 属性命名使用 Pascal 大小写，使用动词或动词短语命名。7 参数命名使用描述性参数名称。参数名称应当具有足够的描述性，以便参数的名称及其类型可用于在大多数情况下确定它的含义。8 变量命名采用Camel大小写的方式。9 控件命名规范遵循相关要求。10 常量命名所有单词大写，多个单词之间用 _ 隔开。11控件命名规范：按钮ID命名：btn+按钮操作功能与数据操作相关：其ID为相应的字段名称。其它控件为前缀+用途功能。八 自行测试类1在测试过程中，首先需要对各子单元过程进行测试,在各子单元过程测试完毕后，再对各模块（包