当前位置：文档之家› java-web开发规范文档

java-web开发规范文档

java-web开发规范文档

java-web开发规范文档

Java web开发规范

1、前言

为了使软件开发过程有章可循，保证软件质量，加强开发管理。

2、开发管理

3、命名规范

3.1 项目编号命名规范

命名方式：项目英文/中午拼音名称_开发组编号_序列号

序列号由3为数字组成，不足的用’0’补齐。

3.2 文档命名规范

命名方式：项目英文/中午拼音名称_文档名称_序列号_编写人名称/编号

3.3 jsp/html命名规范

1、jsp与html文件名全部小写，并遵循如下的规范：

a.数据/内容显示页:

名词，多个单词用下划线分隔，要求能说明显示内容的信息，为避免冲突，可加上“_list”。例如：

new_message.html 或my_file_list.jsp

b.操作处理页

命名格式：名词_下划线_动词，例如：file_delete.jsp。

c.含frame页面

中的name属性命名的格式是①xxx_②xxx_③xxx

①xxx部分用来标识当前页面隶属于整个系统中的哪一功能模块。

如：属于ebwebmail模块则写ebwebmail，其它情况依次类推。

②xxx部分标识当前页面所要完成的功能。

如：完成用户登录的功能则被标识为login，其它情况依次类推。

③xxx部分用来用来表示页面在浏览器窗口所处的位置。

处于浏览器窗口的顶部则标识为top，其它情况依次类推。

例如：ebwebmail_inbox_top.jsp

src属性相应的文件名根据情况建议在原命名规范上用下划线加上所处窗口的位置。

2、javascript脚本文件命名方式：

脚本函数都以①xxx_②xxx的方式命名。

①xxx对应页面隶属的模块。

②xxx表示函数所要实现的功能(动宾结构)，多个单词用下划线连接。

例如：ebwebmail_send_mail()

模块通用的脚本函数必须集合于一个js文件中，在页面上通过

language=”javascript” src=”url”>形式导入。js文件名命名使用模块名，例如：ebwebmail.js。

如果项目已经提供了公共js脚本，则优先使用公共js脚本中提供的函数。

所有定义方法的

注意：必须指定一个有意义的，严禁出现“Untitled”或“未命名”之类的<title>。</p><p>2. 所有html标签使用小写</p><p>3. html页面一般需要设置一个背景色（一般是#FFFFFF）。</p><p>html语法校验</p><p>所有的jsp/html页面需要能够使用DreamWeaver正确打开（即html语法正确，没有错误的标记）。</p><p>注释</p><p>一般不使用html注释，除非是有必要让最终用户看到的内容。对于包含JSP代码的html块，必须使用JSP注释。对于没有必要的注释，在发行版本中必须移除。</p><p>form属于域的maxlength</p><p>对于text类型的输入域，必须根据数据库字段的长度设置相应的maxlength，例如数据库类型是VARCHAR(64)，那么maxlength是32（因为中文浏览器对于中文也认为是一个字符）。</p><p>6、项目规范</p><p>6.1应用程序目录规范</p><p>6.1.1 Java源文件目录</p><p>6.1.2 Web应用程序目录规范</p><p>7、其他规范</p><p>对于IDE的使用</p><p>目前暂不限制开发工具的使用，但是最后提交的代码必须不依赖任何IDE，而需要可以使用ant完成所有的编译工作。一般提交的代码目录格式如下：</p><p>|_dist（存放输出的文件class文件）</p><p>|_lib（使用的库）</p><p>|_src（源代码）</p><p>|_docs（文档）</p><p>|_wwwroot（页面文件）</p><p>|_build.xml（ant的build文件）</p><p>|_changes.log（代码版本和修改的日志）</p><p>此条内容，暂时不执行。</p><p>限制session的使用</p><p>在代码中使用session需要听取项目经理的意见，项目经理需要在设计文档中登记项目中所有使用到的session的名字和作用。</p><p>限制外部包的使用</p><p>开发员如果需要使用一个外部包需要听取项目经理的意见。在项目经理批准以前，严禁擅自使用一个外部的包。</p><h2>(国内标准)GB-软件开发主要文档编写规范</h2><p>231 GB 8567－88软件开发主要文档编写规范本附录中列出了《计算机软件产品开发文件编制指南》GB 8567－88中主要软件文档的编写说明，供编写时参考。这些文档主要是：可行性研究报告、项目开发计划、软件需求说明书、概要设计说明书、详细设计说明书、模块开发卷宗、测试计划、测试分析报告、项目开发总结报告。一、可行性研究报告 l 引言 1.1 编写目的说明：说明本可行性研究报告的编写目的，指出预期的读者。 1.2 背景说明： a ．所建议开发的软件系统的名称。 b ．本项目的任务提出者、开发者、用户及实现该软件的计算中心或计算机网络。 c ．该软件系统同其他系统或其他机构的基本的相互来往关系。 1.3 定义列出本文件中用到的专门术语的定义和外文首字母组词的原词组。 1.4 参考资料列出用得着的参考资料，如： a ．本项目的经核准的计划任务书或合同、上级机关的批文。 b ．属干本项目的其他已发表的文件。 c. 本文件中各处引用的文件、资料，包括所需用到的软件开发标准。列出这些文件资料的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。 2 可行性研究的前提说明对建议开发项目进行可行性研究的前提，如要求、目标、条件、假定和限制等。 2.1 要求说明对所建议开发软件的基本要求，如： a ．功能。 b ．性能。 c ．输出如报告、文件或数据，对每项输出要说明其特征，如用途、产生频度、接口以及分发对象。 d. 输入说明。系统的输入包括数据的来源、类型、数量、数据的组织以及提供的频度。 e ．处理流程和数据流程。用图表的方式表示出最基本的数据流程和处理流程，并输之以叙述。 f. 在安全与保密方面的要求。 g. 同本系统相连接的其他系统。 h. 完成期限。 2.2 目标说明所建议系统的主要开发目标，如： a. 人力与设备费用的减少。 b. 处理速度的提高。 c. 控制精度或生产能力的提高。</p><h2>软件开发文档规范</h2><p>附2: 软件文档编写向导文档分类项目包括如下几类文档：项目管理文档。包括：《软件项目计划》、《项目进度报告》、《项目开发总结报告》软件开发文档。包括：《需求规格说明》、《概要设计说明》、《详细设计说明》、《测试计划》、《软件测试分析报告》。产品文档。包括：《用户操作手册》《演示文件》。软件项目计划（Software Project Plan）一?引言 1?编写目的（阐明编写软件计划的目的，指出读者对象。） 2?项目背景（可包括：（1 ）项目委托单位、开发单位和主管部门；（2）该软件系统与其他系统的关系。） 3?定义（列出本文档中用到的专门术语的定义和缩略词的原文。） 4?参考资料（可包括：文档所引用的资料、规范等；列出资料的作者、标题、编号、发表日期、出版单位或资料来源。）二?项目概述 1.工作内容（简要说明项目的各项主要工作，介绍所开发软件的功能性能等?若不编写可行性研究报告，则应在本节给出较详细的介绍。） 2.条件与限制（阐明为完成项目应具备的条件开发单位已具备的条件以及尚需创造的条件?必要时还应说明用户及分合同承包者承担的工作完成期限及其它条件与限制。） 3.产品（1）程序（列出应交付的程序名称使用的语言及存储形式。）（2）文档（列出应交付的文档。）（3 ）运行环境（应包括硬件环境软件环境。） 4?服务（阐明开发单位可向用户提供的服务?如人员培训安装保修维护和其他运行支持。 5.验收标准</p><p>三.实施计划 1.任务分解（任务的划分及各项任务的负责人。） 2?进度（按阶段完成的项目，用图表说明开始时间完成时间。） 3?预算 4?关键问题（说明可能影响项目的关键问题，如设备条件技术难点或其他风险因素，并说明对策。）四.人员组织及分工五.交付期限六.专题计划要点（如测试计划等。）项目开发进度报告一.报告时间及所处的开发阶段二.给出进度 1.本周的主要活动 2.实际进展与计划比较三.所用工时（按不同层次人员分别计时。）四.所有机时五.工作遇到的问题及采取的对策六.本周完成的成果七.下周的工作计划八.特殊问题项目开发总结报告一.引言 1.编写目的（阐明编写总结报告的目的，指明读者对象。） 2.项目背景（说明项目的来源、委托单位、开发单位及主管部门。） 3.定义（列出报告中用到的专门术语定义和缩写词的原意。） 4.参考资料（列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：（1 ）项目开发计划；（2 ）需求规格说明书；（3 ）概要设计说明书；（4 ）详细设计说明</p><h2>(完整word版)WEB前端开发代码使用要求规范</h2><p>WEB前端代码规范规范目的为提高团队协作效率，便于后台人员添加功能及前端后期优化维护，输出高质量的文档，特制订此文档。本规范文档一经确认，前端开发人员必须按本文档规范进行前台页面开发。本文档如有不对或者不合适的地方请及时提出，经讨论决定后方可更改。基本准则符合web标准；语义化html；结构、表现、行为分离；兼容性优良。页面性能方面，代码要求简洁明了有序，尽可能的减小服务器负载，保证最快的解析速度。文件规范</p><p>3.jsp文件命名：英文驼峰式命名，文件名.jsp。按实际模块需求命名。 4.css文件命名：英文驼峰式命名，文件名.css。共用base.css，首页index.css，其他页面按实际模块需求命名。 5.js文件命名：英文驼峰式命名，文件名.js。共用common.js，其他依实际模块需求命名。 html书写规范 1.文档类型声明及编码：统一为html5的声明类型<!DOCTYPE html>；编码统一为 <meta charset="utf-8"/>，书写时利用IDE实现层次分明的缩进。 2.非特殊情况下css文件必须在<head>...</head>之间引入，选择link方式引入而非 @import形式。 3.非特殊情况下js文件必须在页面底部引入。 4.引入样式文件或JavaScript文件时，须略去默认类型声明，写法如下：</p><p>11.语义化html，如标题根据重要性用h1-h6(同一页面只能有一个h1)，段落标记用p，列表用ul，内联元素中不可嵌套块状元素。 12.尽可能减少div的嵌套层数。 13.在页面中尽量避免使用内嵌样式表，即在标签内使用style="…"。 14.以背景形式呈现的图片，尽量写入css样式中；重要图片必须加上alt属性； 15.特殊符号使用：尽可能使用代码替代：比如<(<)、>(>)、空格( )、&(&)、 ”（"）等等； 16.尽量避免使用过度复杂的HTML结构。 css书写规范 1.编码统一为utf-8。 2.为了避免一些浏览器兼容性问题以及增加样式重用性，每个页面必须引入base.css（详见附件一），此文件不可随意修改。 3.class与id的使用：id是唯一的并是父级的，class是可以重复的并是子级的，所以id 仅使用在大的模块上，class可用在重复使用率高及子级中。 4.为JavaScript预留钩子的命名，请以js_起始，比如：js_hide，js_show。 5.class与id命名：使用英文命名，命名要语义化，简明化，但不要使用诸如first，last 之类的命名。使用驼峰式和下划线分隔相结合的命名规则，即命名应以父级加子级的命名规范，如：父级的类为simple 子级的类应该为simple_first，以此类推，但是尽量避免出现超过四级的类命名。 6.css属性书写顺序，建议遵循：自身属性-->布局定位属性-->文本属性-->其他属性。此条可根据自身习惯书写，但尽量保证同类属性写在一起。</p><h2>Java开发规范</h2><p>Java开发规范</p><p>目录第1章序言 (4) 第2章java一般性研发规范 (5) 2.1 代码格式 (5) 2.1.1包、类、方法的命名规范: (5) 2.1.2方法的命名应注意避免与java中具有特殊意义的名称例如equals， hashCode，clone，finalizer等冲突 (7) 2.1.3Java bean中取得boolean类型的属性值必须使用is****形式命名 (9) 2.1.4if,else,while,for等必须使用{} (9) 2.1.5类必须包含在包里，禁止出现无包的类 (10) 2.1.6类和方法必须拥有注释，注释量占总体代码25%以上，类头部，以及方法头部的注释应符合javadoc标准。 (11) 2.2 基本语法 (12) 2.2.1不能随意捕捉异常，原则上谁捕捉谁处理 (12) 2.2.2if，while，try，finally，switch ，synchronized ，static instantiation 里面应有相应的逻辑处理，不能为空。 (13) 2.2.3在处理循环中，不能在程序中人为的改变步长。 (14) 2.2.4将简单类型int，short，float，double等转化成字符串时，需使用其对应类的toString方法。 (14) 2.2.5javaBean中hashCode，以及equals方法必须同时override。 (15) 2.2.6懒式方式创建对象：不能采用双检查惯用法 (18) 2.2.7不能在finally中返回值。 (19) 2.2.8Boolean实例化时，应用使用Boolean.valueOf，Boolean.TRUE， Boolean.FALSE。 (19) 2.2.9Integer,Byte,Short,Long等实例化时，应用使用valueOf (20) 2.2.10对于多个if语句嵌套的情况下能够整合尽量整合。 (20) 2.2.11override function，不能只有super.function语句，否则视为无效代码 21 2.2.12Collection.toArray的注意事项。 (21) 2.2.13对于BigDecimal方法，应避免使用float值，double值进行创建，应使用字符串形式创建。 (22) 2.2.14String,BigDecimal,BigInteger等值类型调用replace，add等方法的注意事项。 (23) 2.2.15需要注意的引起NullException的语句。 (23) 2.2.16ResultSet使用next时，需要判断是否具有记录再进行一下步操作。 25 2.2.17字符串使用相应的规则。 (25) 2.2.18禁止直接调用 System.gc(),System.getRuntime().gc(),System.runFinalization()。 (27) 2.2.19finalize相应的规则。 (27) 2.2.20禁止在代码中使用System.out,ex.printStackTrace打印日志。 (28) 2.2.21系统资源释放（谁创建的，谁关闭） (29) 2.2.22使用Clone时相应的规则。 (32) 2.2.23java Bean类必须实现Serialize接口。 (33)</p><h2>Web前端开发规范手册参考</h2><p>Web前端开发规范参考手册一、规范目的 1.1 概述为提高团队协作效率，便于后台人员添加功能，及前端后期优化维护，输出高质量的文档，特制订此文档。本规范文档一经确认，前端开发人员必须按本文档规范进行前台页面开发。本文档如有不对或者不合适的地方请及时提出，经讨论决定后可以更改。 1.2 基本准则符合web标准，语义化HTML，结构表现行为分离，兼容性优良。页面性能方面，代码要求简洁明了有序，尽可能的减小服务器负载，保证最快的解析速度。二、规范细则 2.1 文件命名规则文件名称统一用小写的英文字母、数字和下划线的组合，其中不得包含汉字、空格和特殊字符。命名原则的指导思想： ●一是使得工作组的每一个成员能够方便的理解每一个文件的意义。 ●二是当在文件夹中使用“按名称排例”的命令时，同一种大类的文件能够排列在一起，以便查找、修改、替换、计算负载量等等操作。 1. HTML命名原则 ●引导文件统一使用index.htm、index.html、ndex.asp文件名（小写）。 ●各子页命名的原则首先应该以栏目名的英语翻译取单一单词为名称。例如： ?关于我们\ aboutus ?信息反馈\ feedback ?产品\ product ●如果栏目名称多而复杂并不好以英文单词命名，则统一使用该栏目名称拼音或拼音的首字母表示；每一个目录中应该包含一个缺省的html 文件，文件名统一用 index.htm、index.html、index.asp。</p><p>2. 图片命名原则 ●图片的名称分为头尾两部分，用下划线隔开，头部分表示此图片的大类性质。例如：广告、标志、菜单、按钮等。 ●放置在页面顶部的广告、装饰图案等长方形的图片取名：banner。 ●标志性的图片取名：logo。 ●在页面上位置不固定并且带有链接的小图片取名：button 。 ●在页面上某一个位置连续出现，性质相同的链接栏目的图片取名：menu。 ●装饰用的照片取名：pic。 ●不带链接表示标题的图片取名：title。例如： banner_sohu.gif banner_sina.gif menu_aboutus.gif menu_job.gif title_news.gif logo_police.gif logo_national.gif pic_people.jpg ●鼠标感应效果图片命名规范为"图片名+_+on/off"。例如： menu1_on.gif menu1_off.gif 3. Javascript命名原则例如： ●广告条的javascript文件名为ad.js ●弹出窗口的javascript文件名为pop.js 4. 动态语言文件命名原则以性质_描述，描述可以有多个单词，用“_”隔开，性质一般是该页面得概要。例如：register_form.asp register_post.asp topic_lock.asp 2.2 文件存放位置规范 HTML、CSS、js、images文件均归档至<系统开发规范>约定的目录中。 _Root cn 存放中文HTML文件 en 存放英文HTML文件 flash 存放Flash文件 images 存放图片文件 imagestudio 存放PSD源文件</p><h2>JAVA开发规范文档</h2><p>Java 开发规范文档一：目的使本组织能以标准的，规范的方式设计和编码。通过建立编码规范，以使每个开发人员养成良好的编码风格和习惯；并以此形成开发小组编码约定，提高程序的可靠性，可读性，可修改性，可维护性和一致性等，增进团队间的交流，并保证软件产品的质量。二：代码组织与风格 1：长度：为便于阅读和理解，单个函数的有效代码长度当尽量在100行以内（不包括注释行），当功能模块过大时往往采用使用子函数将相应的功能抽取出来，这也有利于提高代码的重用度。 2：单个类不宜过大，当出现此类过大时当将相应功能的代码重构到其他类中，通过组合等方式来调用，建议单个类的长度包括注释行不超过1500行。尽量避免使用大类和长方法。3：间隔：类，方法及功能块间等应以空行相隔，以增加可读性，但不得有无规则的大片空行。操作符两端应当各空一个字符以增加可读性。三：注释 1：注释应该增加代码的清晰度。代码注释的目的时要使代码更易于被其他开发人员等理解。2：保持注释的简洁。 3：注释信息应该包括代码的功能。 4：除变量定义等较短语句的注释使用行尾注释外，其他注释当避免使用行尾注释。 5：JavaDoc规范对类，方法，变量等注释需要符合javadoc规范，对每个类，方法都应详细说明其功能条件，参数等。类注释中应当包含版本和作者信息。 1）类，接口注释在类，接口定义之前当对其进行注释，包括类，接口的目的，作用，功能，继承于何种父类，实现的接口，实现的算法，使用方法，示例程序等。 2）方法注释以明确该方法功能，作者，各参数含义以及返回值等。</p><p>3）其他注释应对重要的变量及不易理解的分支条件表达式加以注释，以说明其含义等。四命名规范 1：对变量，类，接口及包的命名应该使用英文。严禁使用汉语拼音及不相关单词命名。更不可以使用汉字来进行命名。采用大小写混合，提高名字的可读性。一般应该采用小写字母，但时类和接口的名称的首字母，以及任何中间单词的首字母应该大写。包名全部小写。 2：尽量少用缩写，但如果一定要用，当使用公共缩写和习惯缩写等，如implement可缩写为impl，manager可缩写成mgr等。 3：包名一般以项目或模块名命名，少用缩写和长名，一律小写。包名按照如下规定组成[基本包].[项目名].[模块名].[子模块名].…. 如：org.skyinn.skyhome.dao.hibernate。不得将类直接定义在基本包下，所有项目中的类，接口等都当定义在各自的项目和模块包中。 4：类，接口所有单词首字母大写，最好能够见名知意。一般采用名词。接口可带I前缀。或able，dao后缀。 5：字段常量采用完整的英文大写单词，单词之间用下划线连接，如DEFAULT_V ALUE. 6：变量和参数对不易识别出该变量类型的变量应使用类型缩写作其前缀，如字符串使用strXXX，boolean使用isXXX，hasXXX等等。除第一个单词外其余单词的首字母大写。7：集合采用复数名称来表示队列中存放的对象类型，名词采用完整的英文描述。例如：Vector vProducts= new Vector(); Array aryUsers= new Array(); 8：方法方法的名称应采用完整的英文描述，大小写混合使用：所有中间单词的第一个字母大写。方法名称的第一个单词常常采用一个强烈动作色彩的动词。取值类使用get前缀，设置类使用set前缀。例如getName（），setSarry（）。 9：异常类名由表示该异常类型的单词和Exception组成，如ActionException。异常实例一般使用e，ex等。 10：数组的命名数组应该总是用下面的方式来命名：byte[] buffer; 而不是：byte buffer[]; 五：类与接口 1：基本原则：一个类只做一件事情。另一个原则时根据每个类的职责进行划分，比如用User 来存放用户信息，而用UserDAO来对用户信息进行数据访问操作，用UserServer对用户信息的业务操作等等。多个类中使用相同方法时将其方法提到一个接口中或使用抽象类，尽量提高重用度。不希望被实例化的类的缺省构造方法声明为private。 2：一般而言，接口定义行为，而抽象类定义属性和共有行为，注意2者的取舍，在设计中可由接口定义公用的行为，由一个抽象类来实现其部分或全部方法，以给子类提供统一的行为为定义。六：方法一个方法只完成一项功能。方法参数类型和参数返回值尽量接口化，以屏蔽具体的实现细节，提高系统的可扩展性，例如：public void addUser（List userList）{} public List listAllUsers（）{} 七：Web 命名规范一：jsp页面命名对于某个功能块的增删改查页面定义，最好使用</p><h2>软件开发文档标准</h2><p>可行性研究报告来源：国家计算机标准和文件模板作者：可行性研究报告的编写目的是：说明该软件开发项目的实现在技术、经济和社会条件方面的可行性；评述为了合理地达到开发目标而可能选择的各种方案；说明并论证所选定的方案。可行性研究报告的编写内容要求如下： 1 引言 1．1编写目的说明编写本可行性研究报告的目的，指出预期的读者。 1．2背景说明： a．所建议开发的软件系统的名称； b．本项目的任务提出者、开发者、用户及实现该软件的计算中心或计算机网络； C．该软件系统同其他系统或其他机构的基本的相互来往关系。 1．3定义列出本文件中用到的专门术语的定义和外文首字母组词的原词组。 1．4参考资料列出用得着的参考资料，如： a．本项目的经核准的计划任务书或合同、上级机关的批文； b．属于本项目的其他已发表的文件； C．本文件中各处引用的文件、资料，包括所需用到的软件开发标准。| 列出这些文件资料的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。 2 可行性研究的前提说明对所建议的开发项目进行可行性研究的前提，如要求、目标、假定、限制等。 2．1要求说明对所建议开发的软件的基本要求，如： a．功能； b．性能； C．输出如报告、文件或数据，对每项输出要说明其特征，如用途、产生频度、接口以及分发对象； d．输入说明系统的输入，包括数据的来源、类型、数量、数据的组织以及提供的频度； e．处理流程和数据流程用图表的方式表示出最基本的数据流程和处理流程，并辅之以叙述； f．在安全与保密方面的要求； g．同本系统相连接的其他系统；</p><p>h．完成期限。 2．2目标说明所建议系统的主要开发目标，如： a．人力与设备费用的减少； b．处理速度的提高； C．控制精度或生产能力的提高； d．管理信息服务的改进； e．自动决策系统的改进； f．人员利用率的改进。 2．3条件、假定和限制说明对这项开发中给出的条件、假定和所受到的限制，如： a．所建议系统的运行寿命的最小值； b．进行系统方案选择比较的时间； c．经费、投资方面的来源和限制； d．法律和政策方面的限制； e．硬件、软件、运行环境和开发环境方面的条件和限制； f．可利用的信息和资源； g．系统投入使用的最晚时间。 2．4进行可行性研究的方法说明这项可行性研究将是如何进行的，所建议的系统将是如何评价的。摘要说明所使用的基本方法和策略，如调查、加权、确定模型、建立基准点或仿真等。 2．5评价尺度说明对系统进行评价时所使用的主要尺度，如费用的多少、各项功能的优先次序、开发时间的长短及使用中的难易程度。 3 对现有系统的分析这里的现有系统是指当前实际使用的系统，这个系统可能是计算机系统，也可能是一个机械系统甚至是一个人工系统。分析现有系统的目的是为了进一步阐明建议中的开发新系统或修改现有系统的必要性。 3．1处理流程和数据流程说明现有系统的基本的处理流程和数据流程。此流程可用图表即流程图的形式表示，并加以叙述。 3．2工作负荷列出现有系统所承担的工作及工作量。 3．3费用开支列出由于运行现有系统所引起的费用开支，如人力、设备、空间、支持性服务、材料等项开</p><h2>Web前端开发规范手册</h2><p>Web前端开发规范手册一、规范目的 1.1 概述 (1) 二、文件规范 2.1 文件命名规则 (1) 2.2 文件存放位置 (2) 2.3 css 书写规范 (3) 2.4 html书写规范 (7) 2.5 JavaScript书写规范 (11) 2.6 图片规范 (12) 2.7 注释规范 (13) 2.8 css 浏览器兼容 (13) 一、规范目的 1.1 概述为提高团队协作效率, 便于后台人员添加功能及前端后期优化维护, 输出高质量的文档, 特制订此文档. 本规范文档一经确认, 前端开发人员必须按本文档规范进行前台页面开发. 本文档如有不对或者不合适的地方请及时提出, 经讨论决定后可以更改此文档. 二、文件规范 2.1 文件命名规则文件名称统一用小写的英文字母、数字和下划线的组合，其中不得包含汉字、空格和特殊字符；命名原则的指导思想一是使得你自己和工作组的每一个成员能够方便的理解每一个文件的意义，二是当我们在文件夹中使用“按名称排例”的命令时，同一种大类的文件能够排列在一起，以便我们查找、修改、替换、计算负载量等等操作。</p><p>a. HTML的命名原则引文件统一使用index.htm index.html index.asp文件名（小写）各子页命名的原则首先应该以栏目名的英语翻译取单一单词为名称。例如：关于我们\ aboutus 信息反馈\ feedback 产品\ product 如果栏目名称多而复杂并不好以英文单词命名，则统一使用该栏目名称拼音或拼音的首字母表示；每一个目录中应该包含一个缺省的html 文件，文件名统一用index.htm index.html index.asp； b. 图片的命名原则图片的名称分为头尾两部分，用下划线隔开，头部分表示此图片的大类性质例如：广告、标志、菜单、按钮等等。放置在页面顶部的广告、装饰图案等长方形的图片取名：banner 标志性的图片取名为：logo 在页面上位置不固定并且带有链接的小图片我们取名为button 在页面上某一个位置连续出现，性质相同的链接栏目的图片我们取名：menu 装饰用的照片我们取名：pic 不带链接表示标题的图片我们取名：title 范例：banner_sohu.gif banner_sina.gif menu_aboutus.gif menu_job.gif title_news.gif logo_police.gif logo_national.gif pic_people.jpg 鼠标感应效果图片命名规范为"图片名+_+on/off"。例如：menu1_on.gif menu1_off.gif c. javascript的命名原则例如：广告条的javascript文件名为ad.js 弹出窗口的javascript文件名为pop.js d. 动态语言文件命名原则以性质_描述，描述可以有多个单词，用“_”隔开，性质一般是该页面得概要。范例：register_form.asp register_post.asp topic_lock.asp 2.2 文件存放位置规范 _Root cn 存放中文HTML文件 en 存放英文HTML文件 flash 存放Flash文件 images 存放图片文件 imagestudio 存放PSD源文件 flashstudio 存放flash源文件 inc 存放include文件 library 存放DW库文件 media 存放多媒体文件 project 存放工程项目资料</p><h2>华为JAVA编程规范</h2><p>1 Java 编程规范 1.1 排版 1.1.1 规则规则1程序块要采用缩进风格编写，缩进的空格数为4个，不允许使用TAB缩进。(1.42+) 说明：缩进使程序更易阅读，使用空格缩进可以适应不同操作系统与不同开发工具。规则2分界符（如大括号…{?和…}?）应各独占一行，同时与引用它们的语句左对齐。在函数体的开始、类和接口的定义、以及if、for、do、while、switch、case语句中的程序或者static、,synchronized等语句块中都要采用如上的缩进方式。(1.42+) 示例: if (a>b) { doStart(); } 规则3较长的语句、表达式或参数（>80字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读。(1.42+) 示例： if (logger.isDebugEnabled()) { logger.debug("Session destroyed,call-id" + event.getSession().getCallId()); } 规则4不允许把多个短语句写在一行中，即一行只写一条语句(1.42+) 说明：阅读代码更加清晰示例：如下例子不符合规范。 Object o = new Object(); Object b = null; 规则5if, for, do, while, case, switch, default 等语句自占一行，且if, for, do, while,switch等语句的执行语句无论多少都要加括号{},case 的执行语句中如果定义变量必须加括号{}。 (1.42+) 说明：阅读代码更加清晰，减少错误产生示例： if (a>b) { doStart(); }</p><h2>PRD-产品开发项目文档管理系统要求规范</h2><p>产品开发项目文档管理规范文档编号：COSHIP-CMMI-PRD-PDPDM 密级：机密版本信息：1.8 批准日期：编辑软件：Microsoft Word 2003 Microsoft Visio 2003 同洲电子股份有限公司版权所有内部资料注意保密</p><p>*变化状态：C――创建，A——增加，M——修改，D——删除</p><p>目录 1 概述 (1) 1.1 目的 (1) 1.2 适用范围 (1) 2 产品开发文档体系 (1) 3 文档质量的度量准则 (3) 4 主要角色和职责 (3) 4.1 文档作者 (3) 4.2 项目经理 (4) 4.3 PPQA (4) 4.4 配置管理工程师 (4) 4.5 评审组 (4) 4.6 部门经理 (4) 5 文档审核流程 (5) 5.1 审核流程 (5) 5.2 归档签名 (6) 5.3 纳入基线 (6) 6 文档保密制度 (7) 7 文档编号 (7) 7.1 文档编号规则 (7) 7.2 阶段代号 (8) 8 文档版本 (9)</p><p>1概述 1.1目的规范公司产品开发项目的文档体系，加强文档的标准化管理。 1.2适用范围公司内所有产品开发项目。 2产品开发文档体系在产品开发项目开发过程中，各阶段都有相应的文档输出，文档的编写应先于或同步于开发工作。产品开发项目过程中的文档体系如表1所示。表1.产品开发项目文档体系</p><p>3文档质量的度量准则评审文档质量的度量准则有以下六条：完整性：所承担产品开发任务的项目组，需按照公司文档体系的规定编写相应的文档，以保证在项目结束时其文档是齐全的。正确性：在项目各个阶段所编写的文档的内容，必须真实的反映阶段的工作且与该阶段的需求相一致。文档与所述的对象保持一致，必要时应进行实时的文档版本升级。可读性：文档应该表达清晰、逻辑条理分明、表现形式通用。简明性：在项目各个阶段所编写的各种文档的语言表达应该准确简练。规范性：文档的规范性是指采用当前最新的模板。其完整性及内容的充实程度应不低于模板的要求。可追溯性：在项目各个阶段所编写的各种文档应该具有良好的可追溯性。由于各开发阶段编制的文档与各阶段完成的工作有着密切的关系，前后阶段生成的文件，随着开发工作的逐步扩展，具有一定的继承关系。在一个项目各开发阶段之间提供的文件必定存在着可追溯的关系。 4主要角色和职责 4.1文档作者文档作者包括公司内的项目组成员以及外协人员。文档作者在文档方面的主要工作为：1）在项目开发过程的各个阶段中，按照规定及时地完成项目文档的编写工作，文档作者有责任保证文档编写与开发同步。 2）文档作者不仅要审核文档字面上有无错漏，还要审核所陈述的技术内容是否精确，及表达方式上是否清晰易懂。文档作者对文档的正确性、可读性和规范性全面负责。 3）文档作者保证所编写的文档与所描述的对象保持很好的一致性，必要时及时更新文档，便于以后维护工作和后续开发工作的开展。</p><h2>Web前端开发规范手册</h2><p>Web前端开发规范手册修订历史记录日期版本说明作者 2012年12月31日 1.0初稿施昀 2012年01月05日 1.1施昀、戴静2012年01月07日 1.2施昀目录修订历史记录 (1) 一、规范目的 (2) 1.1概述 (2) 二、基本准则 (2) 三、文件规范 (3) 2.1文件命名规则 (3) 2.1.1HTML的命名原则 (3) 2.1.2图片的命名原则 (3) 2.1.3.javascript的命名原则 (4) 2.1.4动态语言文件命名原则 (4) 2.2文件存放位置规范 (4) 2.3CSS书写规范 (4) 2.3.1基本原则 (4)</p><p>2.3.2注意细则 (5) 2.3.3命名规则 (6) 2.4html书写规范 (9) 2.4.1head区代码规范 (9) 2.4.2body区代码规范 (10) 2.5JavaScript书写规范 (10) 2.6图片规范 (10) 2.7注释规范 (11) 2.7.1html注释 (11) 2.7.2css注释 (11) 2.7.3JavaScript注释 (11) 四、执行模式 (12) 一、规范目的 1.1概述提高团队协作效率便于前端开发以及后期优化维护方便新进的成员快速上手输出高质量的代码本规范文档一经确认,前端开发人员必须按本文档规范进行前台页面开发。本文档如有不对或者不合适的地方请及时提出，经讨论决定后可以更新此文档。二、基本准则符合web标准,语义化html,结构表现行为分离,兼容性优良。代码要求简洁明了有序,尽可能的减小服务器负载,保证最快的解析速度。</p><p>开发时需要遵循如上基本准则，特殊情况可以有所宽限，如一些老项目的页面改造。三、文件规范 2.1文件命名规则 [使用场景：在新建网页、图片、脚本、CSS文件时，根据此规则给文件命名并放入指定位置] 文件名称统一用小写的英文字母、数字和下划线的组合，其中不得包含汉字空格和特殊字符。命名原则的指导思想一是使得你自己和工作组的每一个成员能够方便的理解每一个文件的意义，二是当我们在文件夹中使用“按名称排例”的命令时，同一种大类的文件能够排列在一起，以便我们查找、修改、替换、计算负载量等等操作。 2.1.1HTML的命名原则索引文件统一使用index.htm index.html index.asp文件名。如果栏目名称多而复杂并不好以英文单词命名，则统一使用该栏目名称拼音或拼音的首字母表示。每一个目录中应该包含一个缺省的html文件，文件名统一用index.htm index.html index.asp。 2.1.2图片的命名原则图片的名称分为头尾两部分，用下划线隔开，头部分表示此图片的大类性质。例如：广告、标志、菜单、按钮等等。放置在页面顶部的广告、装饰图案等长方形的图片取名：banner 标志性的图片取名为：logo 在页面上位置不固定并且带有链接的小图片我们取名为button 在页面上某一个位置连续出现，性质相同的链接栏目的图片我们取名：menu 装饰用的照片我们取名：pic 不带链接表示标题的图片我们取名：title 范例：banner_sohu.gif banner_sina.gif menu_aboutus.gif menu_job.gif title_news.gif logo_police.gif logo_national.gif pic_people.jpg</p><h2>Java编程规范</h2><p>Java编程规范本文引用阿里Java开发手册。GitHub阅读地址：目录编程规约 - 命名规约 - 常量定义 - 格式规范 - OOP规约 - 集合处理 - 并发处理 - 控制语句 - 注释规约 - 其他 - 异常处理 - 建表规约 - 索引规约 - SQL规约</p><p>- ORM规约编程规约命名规约 1、【强制】所有编程相关命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束反例： _name / __name / $Object / name_ / name$ / Object$1 2、【强制】所有编程相关的命名严禁使用拼音与英语混合的方式，更不允许直接使用中的方式。说明：正确的英文拼写和语法可以让阅读者易于理解，避免歧义。注意，即纯拼音的命名方式也要避免采用。反例： DaZhePromotion [打折] / getPingfenByName() [评分] / int 变量 = 3; 正例： ali / alibaba / taobao / cainiao / aliyun / youku / hangzhou 等国际通用的名称，可视为英文。12345 3、【强制】类名使用 UpperCamelCase 风格，必须遵从驼峰形式，但以下情形例外：（领域模型的相关命名） DO / DTO / VO / DAO 等。正例： MarcoPolo / UserDO / XmlService / TcpUdpDeal / TaPromotion 反例： macroPolo / UserDo / XMLService / TCPUDPDeal</p><p>/ TAPromotion123 4、【强制】方法名、参数名、成员变量、局部变量都统一只用 lowerCamelCase 风格，必须遵从驼峰形式。正例： localValue / getHttpMessage() / inputUserId1 5、【强制】常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长。正例： MAX_STOCK_COUNT 反例： MAX_COUNT123 6、【强制】抽象类命名使用 Abstract 或 Base 开头；异常类命名使用 Exception 结尾；测试类命名以它要测试的类的名称开始，以 Test 结尾。 7、【强制】中括号是数组类型的一部分，数组定义如下：String[] args ; 反例：请勿使用 String args[] 的方式来定义1 8、【强制】 POJO 类中的任何布尔类型的变量，都不要加 is，否则部分框架解析会引起序列化错误。反例：定义为基本数据类型 boolean isSuccess；的属性，它的方法也是 isSuccess()， RPC框架在反向解析的时候，“以为”对应的属性名称是 success，导致属性获取不到，进而抛出异常。1 9、【强制】包名统一使用小写，点分隔符之间有且仅有一</p><h2>java开发规范文档</h2><p>一千零一夜产品部系统开发规范V1.0 一千零一夜途遇科技有限公司 2015-11-03</p><p>修改记录目录 1前言 (4) 2开发管理 (4) 3项目周期 (4) 4命名规范 (5) 4.1项目编号命名规范 (5) 4.2文档命名规范 (5) 4.3路径管理 (5) 4.4jsp/html命名规范 (6) 4.5数据库命名规范 (8) 4.5.1表名规范 (8) 4.5.2字段规范 (8) 5文档规范 (8) 6代码规范 (9) 6.1Java源代码规范 (9) 6.1.1命名 (9) 6.1.2代码格式 (11) 6.1.3注释 (12) 6.1.4其他 (13) 6.2jsp/html代码规范 (13) 6.3数据库开发规范 (15) 6.3.1主键 (15) 6.3.2日期类型 (16) 6.3.3固定字段 (16) 6.3.4取值规范 (16) 6.3.5数据库开发工具 (16)</p><p>6.3.6Sql书写规范 (17) 6.4其他规范 (17) 7实战代码规范 (18) 7.1Java源代码规范 (18) 7.1.1java代码命名与格式 (18) 7.2jsp/html代码规范 (26) 8FAQ (29) 8.1Logic类中新增数据方法怎么写 (29) 8.2Logic类中修改数据方法怎么写 (30) 8.3Logic类中删除数据方法怎么写 (31) 8.4怎样创建一个没有底部按钮的窗口 (32) 8.5怎样设置弹出窗口的标题 (32) 8.6怎样重写提交数据的方法 (33) 8.7怎样创建单grid的页面 (33) 8.8怎样多个页签的grid的页面 (34) 8.9怎样创建左边树右边grid的页面 (34) 9代码检查规定 (34) 10附录1：JPA使用指南javax.persistence的注解配置 (34)</p><h2>新产品项目开发规范</h2><p>项目开发规范文档编写人：徐文兵日期：2009-7-20 审核人：日期：批准人：日期：</p><p>修改记录（REVISION CHART）</p><p>1 概述目的与概述本文档为XX公司的开发规范文档，给开发团队提供开发标准和规范。整体说明在开发规范中包含了两个部分，第一部分是项目开发流程规范，主要阐述在项目开发过程中的各个阶段的规范。第二部分为Coding开发规范，Coding 开发规范阐述了在一个框架中的各个层的开发规范（注：在第一版中不包含对工作流开发的规范制定）覆盖范围阅读对象 1.项目管理人员 2.系统设计人员 3.系统开发人员参考资料略</p><p>2 项目开发流程规范 2.1 业务需求调研阶段 ●调研的目标系统层面：客户的系统运行环境业务层面：了解客户需要什么样的系统，具体了解业务目的，业务逻辑，业务数据，客户的操作习惯，页面风格习惯等。 ●调研的准备工作：行业知识的准备：了解客户的行业背景，行业领域的业务术语，含义。结合客户行业背景，了解客户的业务知识。业务专家需求：在行业领域的复杂度不高的情况下，业务分析人员直接收集并学习行业知识就可以了，但行业知识的准备工作还是要做的在行业领域业务复杂度高的情况下，需要业务专家对客户的业务的进行整理。 ●调研的流程：第一步，项目启动阶段了解客户的IT环境。第二步，讨论并具体确定客户系统的范围，并获得客户业务功能点的原始的单据。在这个过程中准备一个本和一只笔记录讨论的业务信息第三步，整理业务信息，和原始表单，抽取出有效业务信息，并对于不明确的业务信息进行整理和归类，并制作成问卷形式进一步调研。第四步，发放调研问卷，再次进行业务调研（直接转到三）第五步，卷写调研问卷，并内部评审第六步，调研问卷客户评审并确认。 ●调研阶段的交付项（可配置项）软件需求说明书软件需求说明书的目录： 1 客户行业背景 2 客户系统的意义 3 客户系统运行的环境 4 业务功能点描述（业务目的，业务逻辑，业务数据，优先级别，使用频率等） 5 客户的操作习惯，页面风格习惯。</p><h2>Web前端开发试题</h2><p>耐心填一填! 1. 为div设置类a与b,应编写HTML代码_______________ 。 2. 设置CSS属性clear的值为 ______________ 可清除左右两边浮动。 3. _________ 签必须直接嵌套于ul、ol中。 4. CSS属性___________ 为元素设置外补丁。 5. 设置CSS属性float的值为_______________ 可取消元素的浮动。 6. 文字居中的CSS代码是_____________ 二、精心选一选！ 1. 下列哪个样式定义后，内联（非块状）元素可以定义宽度和高度（） A. display:inline B. display:none C. display:block D. display:inheric 2. 选出你认为最合理的定义标题的方法（） A. <span class= ” heading ” > 文章标题</span> B. <b> 文章标题</b> C. <h1>文章标题</h1></p><p>D. <strong> 文章标题</strong> 3. br标签在XHTML中语义为（） A.换行 B.强调 C.段落 D.标题 4. 不换行必须设置（） A.word-break B.l etter-spaci ng C.white-space D.word-spa cing 5. 在使用table表现数据时，有时候表现出来的会比自己实际设置的宽度要宽，为此需要设置下面哪些属性值（） A. cellpadding= ” 0" B. padding:0 C. margin:。 D. cellspacing= ” 0" 三、判断对或错！ 1. CSS属性font-style 用于设置字体的粗细。（） 2. CSS属性overflow 用于设置元素超过宽度时是否隐藏或显示滚动条。（） 3. 在不涉及样式情况下，页面元素的优先显示与结构摆放顺序无关。（） 4. 在不涉及样式情况下，页面元素的优先显示与标签选用无关。（） 5. display:i nli ne 兼容所有的浏览器。（） 6. input属于窗体元素，层级显示比flash、其它元素都高。（）</p> <div> <div>相关主题</div> <div class="relatedtopic"> <div id="tabs-section" class="tabs"> <ul class="tab-head"> <li id="3575981"><a href="/topic/3575981/" target="_blank">开发文档规范</a></li> <li id="19008472"><a href="/topic/19008472/" target="_blank">java开发规范文档</a></li> <li id="23511298"><a href="/topic/23511298/" target="_blank">web前端开发规范手册</a></li> <li id="18348642"><a href="/topic/18348642/" target="_blank">web前端开发规范</a></li> <li id="9160472"><a href="/topic/9160472/" target="_blank">项目开发规范文档</a></li> <li id="20419159"><a href="/topic/20419159/" target="_blank">软件开发过程文档规范</a></li> </ul> </div> </div> </div> <div class="container"> <div>文本预览</div> <div class="textcontent"> </div> </div> </div> <div class="category"> <span class="navname">相关文档</span> <ul class="lista"> <li><a href="/doc/b810927271.html" target="_blank">软件项目开发流程规范文档</a></li> <li><a href="/doc/0d10050911.html" target="_blank">JAVA开发规范文档</a></li> <li><a href="/doc/f916568444.html" target="_blank">软件开发文档规范</a></li> <li><a href="/doc/248277392.html" target="_blank">硬件开发文档规范</a></li> <li><a href="/doc/5a16574300.html" target="_blank">开发功能文档规范</a></li> <li><a href="/doc/a41860786.html" target="_blank">软件开发过程文档规范</a></li> <li><a href="/doc/d35585930.html" target="_blank">软件开发技术文档编写规范==</a></li> <li><a href="/doc/1c15930517.html" target="_blank">HTML／CSS代码开发规范文档</a></li> <li><a href="/doc/3b15013876.html" target="_blank">项目开发规范性文档</a></li> <li><a href="/doc/6715271588.html" target="_blank">软件开发设计文档规范</a></li> <li><a href="/doc/a513761885.html" target="_blank">ETL设计开发规范文档</a></li> <li><a href="/doc/077269543.html" target="_blank">开发文档规范检查</a></li> <li><a href="/doc/ea5370838.html" target="_blank">软件开发文档管理规范</a></li> <li><a href="/doc/211465015.html" target="_blank">软件开发文档编写规范</a></li> <li><a href="/doc/5710276839.html" target="_blank">开发规范及框架说明文档</a></li> <li><a href="/doc/9d11380513.html" target="_blank">软件开发文档编写要求</a></li> <li><a href="/doc/de4850117.html" target="_blank">前端开发设计规范文档</a></li> <li><a href="/doc/1e8883041.html" target="_blank">软件开发文档规范</a></li> <li><a href="/doc/3d12997876.html" target="_blank">ios开发规范文档</a></li> <li><a href="/doc/6214518471.html" target="_blank">产品开发项目文档管理规范</a></li> </ul> <span class="navname">最新文档</span> <ul class="lista"> <li><a href="/doc/0619509601.html" target="_blank">幼儿园小班科学《小动物过冬》PPT课件教案</a></li> <li><a href="/doc/0a19509602.html" target="_blank">2021年春新青岛版(五四制)科学四年级下册 20.《露和霜》教学课件</a></li> <li><a href="/doc/9619184372.html" target="_blank">自然教育课件</a></li> <li><a href="/doc/3319258759.html" target="_blank">小学语文优质课火烧云教材分析及课件</a></li> <li><a href="/doc/d719211938.html" target="_blank">(超详)高中语文知识点归纳汇总</a></li> <li><a href="/doc/a519240639.html" target="_blank">高中语文基础知识点总结(5篇)</a></li> <li><a href="/doc/9019184371.html" target="_blank">高中语文基础知识点总结(最新)</a></li> <li><a href="/doc/8819195909.html" target="_blank">高中语文知识点整理总结</a></li> <li><a href="/doc/8319195910.html" target="_blank">高中语文知识点归纳</a></li> <li><a href="/doc/7b19336998.html" target="_blank">高中语文基础知识点总结大全</a></li> <li><a href="/doc/7019336999.html" target="_blank">超详细的高中语文知识点归纳</a></li> <li><a href="/doc/6819035160.html" target="_blank">高考语文知识点总结高中</a></li> <li><a href="/doc/6819035161.html" target="_blank">高中语文知识点总结归纳</a></li> <li><a href="/doc/4219232289.html" target="_blank">高中语文知识点整理总结</a></li> <li><a href="/doc/3b19258758.html" target="_blank">高中语文知识点归纳</a></li> <li><a href="/doc/2a19396978.html" target="_blank">高中语文知识点归纳(大全)</a></li> <li><a href="/doc/2c19396979.html" target="_blank">高中语文知识点总结归纳(汇总8篇)</a></li> <li><a href="/doc/1619338136.html" target="_blank">高中语文基础知识点整理</a></li> <li><a href="/doc/e619066069.html" target="_blank">化工厂应急预案</a></li> <li><a href="/doc/b019159069.html" target="_blank">化工消防应急预案(精选8篇)</a></li> </ul> </div> </div> <script> var sdocid = "86b1bdd8b52acfc788ebc94b"; </script> <script type="text/javascript">bdtj();</script> <footer class="footer"> <p><a href="/tousu.html" target="_blank">侵权投诉</a> © 2022 www.doczj.com <a href="/sitemap.html">网站地图</a></p> <p> <a href="https://beian.miit.gov.cn" target="_blank">闽ICP备18022250号-1</a> 本站资源均为网友上传分享，本站仅负责分类整理，如有任何问题可通过上方投诉通道反馈 <script type="text/javascript">foot();</script> </p> </footer> </body> </html>