javaweb开发规范文档.docx

上传人:b****5 文档编号:3434699 上传时间:2022-11-23 格式:DOCX 页数:13 大小:22.34KB
下载 相关 举报
javaweb开发规范文档.docx_第1页
第1页 / 共13页
javaweb开发规范文档.docx_第2页
第2页 / 共13页
javaweb开发规范文档.docx_第3页
第3页 / 共13页
javaweb开发规范文档.docx_第4页
第4页 / 共13页
javaweb开发规范文档.docx_第5页
第5页 / 共13页
点击查看更多>>
下载资源
资源描述

javaweb开发规范文档.docx

《javaweb开发规范文档.docx》由会员分享,可在线阅读,更多相关《javaweb开发规范文档.docx(13页珍藏版)》请在冰豆网上搜索。

javaweb开发规范文档.docx

javaweb开发规范文档

Javaweb开发规范

1、前言

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

 

2、开发管理

项目进度周报表格如下:

项目编号

汇报人

汇报日期

项目进度详细描述

 其他问题

3、命名规范

3.1项目编号命名规范

命名方式:

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

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

3.2文档命名规范

命名方式:

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

3.3jsp/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文件中,在页面上通过形式导入。

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注释,除非是有必要让最终用户看到的内容。</p><p>对于包含JSP代码的html块,必须使用JSP注释。</p><p>对于没有必要的注释,在发行版本中必须移除。</p><p>form属于域的maxlength</p><p> 对于text类型的输入域,必须根据数据库字段的长度设置相应的maxlength,例如数据库类型是VARCHAR(64),那么maxlength是32(因为中文浏览器对于中文也认为是一个字符)。</p><p>6、项目规范</p><p>6.1应用程序目录规范</p><p>6.1.1Java源文件目录</p><p>目录名</p><p>说明</p><p>src</p><p>(Java源代码)</p><p>|_cn</p><p>域名倒置</p><p>|_farmers</p><p>域名</p><p>|_common</p><p>公用包</p><p>|_util</p><p>工具包</p><p>|_db</p><p>数据库访问类</p><p>|_…</p><p>其他公用包</p><p>|_action</p><p>公用的action类包</p><p>|_模块名</p><p>模块功能实现包</p><p>|_dao</p><p>数据库访问类包</p><p>|_biz</p><p>模块业务实现类包</p><p>|_action</p><p>模块专用action类包</p><p>6.1.2Web应用程序目录规范</p><p>目录名</p><p>说明</p><p>webpage</p><p>(Web页面源代码)</p><p>|_images</p><p>页面图片</p><p>|_js</p><p>Javascript源代码</p><p>|_css</p><p>样式表文件</p><p> |_admin</p><p>系统管理功能</p><p>|_模块名</p><p>系统管理模块功能实现页面</p><p>|_模块名</p><p>业务模块功能实现页面</p><p>|_web-inf</p><p>Web.xml等文件存放目录</p><p>|_classes</p><p>Java类class文件目录</p><p>*.properties</p><p>配置文件</p><p>|_lib</p><p>应用程序所需类包</p><p>|_config</p><p>系统配置信息</p><p> </p><p>7、其他规范</p><p>对于IDE的使用</p><p>目前暂不限制开发工具的使用,但是最后提交的代码必须不依赖任何IDE,而需要可以使用ant完成所有的编译工作。</p><p>一般提交的代码目录格式如下:</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><p>在项目经理批准以前,严禁擅自使用一个外部的包。</p><p></p> </div> <div class="readmore" onclick="showmore()" style="background-color:transparent; height:auto; margin:0px 0px; padding:20px 0px 0px 0px;"><span class="btn-readmore" style="background-color:transparent;"><em style=" font-style:normal">展开</em>阅读全文<i></i></span></div> <script> function showmore() { $(".readmore").hide(); $(".detail-article").css({ "height":"auto", "overflow": "hidden" }); } $(document).ready(function() { var dh = $(".detail-article").height(); if(dh >100) { $(".detail-article").css({ "height":"100px", "overflow": "hidden" }); } else { $(".readmore").hide(); } }); </script> </div> <script> var defaultShowPage = parseInt("5"); var id = "3434699"; var total_page = "13"; var mfull = false; var mshow = false; function DownLoad() { window.location.href='https://m.bdocx.com/down/3434699.html'; } function relate() { var reltop = $('#relate').offset().top-50; $("html,body").animate({ scrollTop: reltop }, 500); } </script> <script> var pre = "https://file1.bdocx.com/fileroot1/2022-11/22/f780e6ef-31a3-4a5d-9940-2ef4d01b5232/f780e6ef-31a3-4a5d-9940-2ef4d01b5232"; var freepage = parseInt('13'); var total_c = parseInt('13'); var start = defaultShowPage; var adcount = 0; var adindex = 0; var adType_list = ";0;1;2;3;4;5;6;7;8;9;10;11;12;"; var end = start; function ShowSvg() { end = start + defaultShowPage; if (end > freepage) end = freepage; for (var i = start; i < end; i++) { var imgurl = pre + (i + 1) + '.gif'; var html = "<img src='" + imgurl + "' onerror=\"this.src='/images/s.gif'\" alt=\"javaweb开发规范文档.docx_第" + (i + 1) + "页\" width='100%'/>"; $("#page").append("<div class='page'>" + html + "</div>"); $("#page").append("<div class='pageSize'>第" + (i + 1) + "页 / 共" + total_c + "页</div>"); if(adcount > 0 && adType_list.indexOf(";"+(i+1)+";")>-1) { if(adindex > (adcount-1)) adindex = 0; $("#page").append("<div class='pagead' id='addiv"+(i + 1)+"'></div>"); document.getElementById("addiv"+(i + 1)+"").innerHTML =document.getElementById("adpre" + adindex).outerHTML; adindex += 1; } } start = end; if (start > (freepage - 1)) { if (start < total_c) { $("#pageMore").removeClass("btnmore"); $("#pageMore").html("亲,该文档总共" + total_c + "页,到这儿已超出免费预览范围,如果喜欢就下载吧!"); } else { $("#pageMore").removeClass("btnmore"); $("#pageMore").html("亲,该文档总共" + total_c + "页全部预览完了,如果喜欢就下载吧!"); } } } //$(document).ready(function () { // ShowSvg(); //}); </script> <div id="relate" class="container" style="padding:0px 0px 15px 0px; margin-top:20px; border:solid 1px #dceef8"> <div style=" font-size: 16px; background-color:#e5f0f7; margin-bottom:5px; font-weight: bold; text-indent:10px; line-height: 40px; height:40px; padding-bottom: 0px;">相关资源</div> <div id="relatelist" style="padding-left:5px;"> <ul> <li><em class="docx"/></em><a target="_parent" href="https://m.bdocx.com/doc/20939480.html" title="草鱼的钓法资料Word格式文档下载.docx">草鱼的钓法资料Word格式文档下载.docx</a> </li><li><em class="docx"/></em><a target="_parent" href="https://m.bdocx.com/doc/20939132.html" title="路面标志标线施工方案文档格式.docx">路面标志标线施工方案文档格式.docx</a> </li><li><em class="docx"/></em><a target="_parent" href="https://m.bdocx.com/doc/20938741.html" title="《公务员录用体检操作手册试行》Word文档下载推荐.docx">《公务员录用体检操作手册试行》Word文档下载推荐.docx</a> </li><li><em class="docx"/></em><a target="_parent" href="https://m.bdocx.com/doc/20938704.html" title="最新版修订本新编日语第四册单词111课文档格式.docx">最新版修订本新编日语第四册单词111课文档格式.docx</a> </li><li><em class="docx"/></em><a target="_parent" href="https://m.bdocx.com/doc/20938640.html" title="HSK四级词汇文档格式.docx">HSK四级词汇文档格式.docx</a> </li><li><em class="docx"/></em><a target="_parent" href="https://m.bdocx.com/doc/20937606.html" title="电影《岁月神偷》观后感800字精选篇五篇范文Word格式文档下载.docx">电影《岁月神偷》观后感800字精选篇五篇范文Word格式文档下载.docx</a> </li><li><em class="docx"/></em><a target="_parent" href="https://m.bdocx.com/doc/20937598.html" title="高速公路单位分部分项工程具体划分要求Word文件下载.docx">高速公路单位分部分项工程具体划分要求Word文件下载.docx</a> </li><li><em class="docx"/></em><a target="_parent" href="https://m.bdocx.com/doc/20937478.html" title="第一临床医学院党支部书记培训手册讨论稿001Word格式文档下载.docx">第一临床医学院党支部书记培训手册讨论稿001Word格式文档下载.docx</a> </li><li><em class="docx"/></em><a target="_parent" href="https://m.bdocx.com/doc/20937476.html" title="连锁药店门店质量管理制度汇编Word文档下载推荐.docx">连锁药店门店质量管理制度汇编Word文档下载推荐.docx</a> </li><li><em class="docx"/></em><a target="_parent" href="https://m.bdocx.com/doc/20276143.html" title="东方学报总目文档格式.docx">东方学报总目文档格式.docx</a> </li> </ul> </div> </div> <div class="container" style="padding:0px 0px 15px 0px; margin-top:20px; border:solid 1px #dceef8"> <div style=" font-size: 16px; background-color:#e5f0f7; margin-bottom:5px; font-weight: bold; text-indent:10px; line-height: 40px; height:40px; padding-bottom: 0px;">猜你喜欢</div> <div id="relatelist" style="padding-left:5px;"> <ul> <li><em class="docx"></em> <a href="https://m.bdocx.com/doc/3325137.html" target="_parent" title="T梁预制安全教育培训资料.docx">T梁预制安全教育培训资料.docx</a></li> <li><em class="docx"></em> <a href="https://m.bdocx.com/doc/3325138.html" target="_parent" title="dota指令.docx">dota指令.docx</a></li> <li><em class="docx"></em> <a href="https://m.bdocx.com/doc/3325139.html" target="_parent" title="24行测定义判断难点剖析.docx">24行测定义判断难点剖析.docx</a></li> <li><em class="docx"></em> <a href="https://m.bdocx.com/doc/3325140.html" target="_parent" title="00052管理系统中计算机应用实践复习资料+参考答案.docx">00052管理系统中计算机应用实践复习资料+参考答案.docx</a></li> <li><em class="docx"></em> <a href="https://m.bdocx.com/doc/3325141.html" target="_parent" title="AvidMediaComposer中文教程.docx">AvidMediaComposer中文教程.docx</a></li> <li><em class="docx"></em> <a href="https://m.bdocx.com/doc/3325142.html" target="_parent" title="639号地块8号区商品房项目.docx">639号地块8号区商品房项目.docx</a></li> <li><em class="docx"></em> <a href="https://m.bdocx.com/doc/3325143.html" target="_parent" title="matlab数值数组及向量化运算.docx">matlab数值数组及向量化运算.docx</a></li> <li><em class="docx"></em> <a href="https://m.bdocx.com/doc/3325144.html" target="_parent" title="DB2 Sql优化与锁.docx">DB2 Sql优化与锁.docx</a></li> <li><em class="docx"></em> <a href="https://m.bdocx.com/doc/3325145.html" target="_parent" title="《火》大班安全教案.docx">《火》大班安全教案.docx</a></li> </ul> </div> </div> <div style=" font-size: 16px; background-color:#e5f0f7; margin-top:20px; font-weight: bold; text-indent:10px; line-height: 40px; height:40px; padding-bottom: 0px; margin-bottom:10px;"> 相关搜索</div> <div class="widget-box pt0" style="border: none; padding:0px 5px;"> <ul class="taglist--inline multi"> <li class="tagPopup"><a target="_parent" class="tag tagsearch" rel="nofollow" href="https://m.bdocx.com/search.html?q=javaweb">javaweb</a></li> <li class="tagPopup"><a target="_parent" class="tag tagsearch" rel="nofollow" href="https://m.bdocx.com/search.html?q=%e5%bc%80%e5%8f%91">开发</a></li> <li class="tagPopup"><a target="_parent" class="tag tagsearch" rel="nofollow" href="https://m.bdocx.com/search.html?q=%e8%a7%84%e8%8c%83">规范</a></li> <li class="tagPopup"><a target="_parent" class="tag tagsearch" rel="nofollow" href="https://m.bdocx.com/search.html?q=%e6%96%87%e6%a1%a3">文档</a></li> </ul> </div> <br /> <div > 当前位置:<a target="_parent" href="https://m.bdocx.com/">首页</a> > <a href="https://m.bdocx.com/booklist-00017.html">小学教育</a><span> > </span><a href="https://m.bdocx.com/booklist-0001700005.html">学科竞赛</a> </div> <br /> <div class="cssnone"> <iframe title="来源" src="https://m.bdocx.com/BookRead.aspx?id=OMYDV5zPJrE%3d&parto=VNXNEN%2fdF%2fWdgAcRZ1XvLoEMvoiEdQTLc3Dy4zwHJehh2b%2bxYR8GaN9X4f09F9q4MJOPL%2bweoZZiW4Q9TtnJ7qkkLZN4bAZAPCZJfj7hlBD%2fMlnrKHKLoQf0QDuIG6DRA8kzQCxHnhC6wG9vEkPAsH4%2bAgAkS5q7%2fwog0pY3lquOaNc%2bhHwxLvoXpn0QnxQwnk5aYxBhoD7%2fis2PQaYkCMMzCVhUjW7f" frameborder="0" style="width: 0px; height: 0px"> </iframe> </div> <span id="LabelScript"></span> <script src="https://mstatic.bdocx.com/JS/bootstrap-collapse.js"></script> </form> <div class="siteInner_bg" style="margin-top: 40px; border: solid 0px red; margin-left: 0px; margin-right: 0px;"> <div class="siteInner"> <p style="text-align: center;">copyright@ 2008-2022 冰豆网网站版权所有</p><p style="text-align: center;">经营许可证编号:<a href="http://beian.miit.gov.cn/" target="_blank">鄂ICP备2022015515号-1</a></p><script>var _hmt = _hmt || []; (function() { var hm = document.createElement("script"); hm.src = "https://hm.baidu.com/hm.js?2e77bd3f6fe91b0e21d3f22267249ee3"; var s = document.getElementsByTagName("script")[0]; s.parentNode.insertBefore(hm, s); })();</script><script>(function(){ var el = document.createElement("script"); el.src = "https://lf1-cdn-tos.bytegoofy.com/goofy/ttzz/push.js?81476e42bf626128cf29544ee216a8ed7deb9487dce7ed62313212129c4244a219d1c501ebd3301f5e2290626f5b53d078c8250527fa0dfd9783a026ff3cf719"; el.id = "ttzz"; var s = document.getElementsByTagName("script")[0]; s.parentNode.insertBefore(el, s); })(window)</script> </div> </div> <div class="trnav clearfix" id="navcontent" style="display: none; background-color:#3a71b1; "> <div class="trlogoside" id="navlogo" style="display: none;"> <a href="https://m.bdocx.com/" title="冰豆网"><img src="https://www.bdocx.com/images/logo_bd.png" alt="冰豆网"></a> <div class="trnavclose" id="navclose"> <span></span> </div> </div> <div class="navcontainer"> <div class="row"> <ul class="nav navbar-nav trnavul headercontent" id="navigation" style="margin:20px 0 0px;"> <li><a target="_parent"href="https://m.bdocx.com/login.aspx">登录</a></li> <li><a target="_parent"href="https://m.bdocx.com/">首页 </a></li> <li><a target="_parent"href="https://m.bdocx.com/booklist-0.html">资源分类 </a></li> <li><a target="_parent"href="https://m.bdocx.com/UserManage/Recharge.aspx?f=0"><img src="https://m.bdocx.com/images/s.gif" alt="new" class="hottip1">升级会员 <img src="https://www.bdocx.com/FileUpload/Images/48520fea-bc98-41ae-b183-84689c7075c9.gif" alt="new" class="hottip"></a></li> <li><a target="_parent"href="https://m.bdocx.com/newslist.html">通知公告 </a></li> <li><a target="_parent"href="https://m.bdocx.com/h-0.html">帮助中心 </a></li> </ul> </div> </div> </div> <script type="text/javascript"> function stopPropagation(e) { var ev = e || window.event; if (ev.stopPropagation) { ev.stopPropagation(); } else if (window.event) { window.event.cancelBubble = true;//兼容IE } } $("#navmore").click(function (e) { $("#navcontent").show(); $("#navlogo").show(); stopPropagation(e); var navcontentwidth = $("#navcontent").width(); $('#navcontent').css({ 'right': '-' + navcontentwidth + 'px' }); $("#navcontent").show().animate({ "right": 0 }, 300); }); $(document).bind('click', function () { var navcontentwidth = $("#navcontent").width(); $("#navcontent").animate({ 'right': '-' + navcontentwidth + 'px' }, 300, function () { $("#navcontent").hide(); }); $("#navlogo").fadeOut(300); }); $("#navcontent").click(function (e) { stopPropagation(e); }); $("#navclose").click(function (e) { var navcontentwidth = $("#navcontent").width(); $("#navcontent").animate({ 'right': '-' + navcontentwidth + 'px' }, 300, function () { $("#navcontent").hide(); }); $("#navlogo").fadeOut(300); }); </script> <script> function BaseShare(title, desc, imgUrl) { var link = "https://m.bdocx.com/doc/3434699.html"; if (wx) { wx.config({ debug: false, // 开启调试模式,调用的所有api的返回值会在客户端alert出来,若要查看传入的参数,可以在pc端打开,参数信息会通过log打出,仅在pc端时才会打印。 appId: 'wx4f717640abfd1120', // 必填,公众号的唯一标识 timestamp: '1720917057', // 必填,生成签名的时间戳 nonceStr: 'AA942AB2BFA6EBDA4840E7360CE6E7EF', // 必填,生成签名的随机串 signature: 'eed75757a2b161e7b2e15f7de548faf68f5d0df4',// 必填,签名,见附录1 jsApiList: ['onMenuShareAppMessage', 'onMenuShareTimeline', 'updateAppMessageShareData', 'updateTimelineShareData', 'hideMenuItems'] // 必填,需要使用的JS接口列表,所有JS接口列表见附录2 //openTagList: ["wx-open-launch-weapp"]//H5打开小程序 }); wx.ready(function () { //需在用户可能点击分享按钮前就先调用 wx.hideMenuItems({// 要隐藏的菜单项,只能隐藏“传播类”和“保护类”按钮,所有menu项见附录3 menuList: ['menuItem:share:qq', 'menuItem:favorite', 'menuItem:share:QZone', 'menuItem:share:email', 'menuItem:originPage', 'menuItem:readMode', 'menuItem:delete', 'menuItem:editTag', 'menuItem:share:facebook', 'menuItem:share:weiboApp', 'menuItem:share:brand'] }); var shareData = { title: title, // 分享标题 desc: desc,//这里请特别注意是要去除html link: link, // 分享链接,该链接域名或路径必须与当前页面对应的公众号JS安全域名一致 imgUrl: imgUrl, // 分享图标 }; wx.updateAppMessageShareData(shareData);//1.4 分享到朋友 wx.updateTimelineShareData(shareData);//1.4分享到朋友圈 }); } } function BaseShare(title, desc, imgUrl, link) { if (link=="") link = "https://m.bdocx.com/doc/3434699.html"; if (wx) { wx.config({ debug: false, // 开启调试模式,调用的所有api的返回值会在客户端alert出来,若要查看传入的参数,可以在pc端打开,参数信息会通过log打出,仅在pc端时才会打印。 appId: 'wx4f717640abfd1120', // 必填,公众号的唯一标识 timestamp: '1720917057', // 必填,生成签名的时间戳 nonceStr: 'AA942AB2BFA6EBDA4840E7360CE6E7EF', // 必填,生成签名的随机串 signature: 'eed75757a2b161e7b2e15f7de548faf68f5d0df4',// 必填,签名,见附录1 jsApiList: ['onMenuShareAppMessage', 'onMenuShareTimeline', 'updateAppMessageShareData', 'updateTimelineShareData', 'hideMenuItems'] // 必填,需要使用的JS接口列表,所有JS接口列表见附录2 //openTagList: ["wx-open-launch-weapp"]//H5打开小程序 }); wx.ready(function () { //需在用户可能点击分享按钮前就先调用 wx.hideMenuItems({// 要隐藏的菜单项,只能隐藏“传播类”和“保护类”按钮,所有menu项见附录3 menuList: ['menuItem:share:qq', 'menuItem:favorite', 'menuItem:share:QZone', 'menuItem:share:email', 'menuItem:originPage', 'menuItem:readMode', 'menuItem:delete', 'menuItem:editTag', 'menuItem:share:facebook', 'menuItem:share:weiboApp', 'menuItem:share:brand'] }); var shareData = { title: title, // 分享标题 desc: desc,//这里请特别注意是要去除html link: link, // 分享链接,该链接域名或路径必须与当前页面对应的公众号JS安全域名一致 imgUrl: imgUrl, // 分享图标 }; wx.updateAppMessageShareData(shareData);//1.4 分享到朋友 wx.updateTimelineShareData(shareData);//1.4分享到朋友圈 }); } } </script> <script> $(document).ready(function () { var arr = $(".headercontent"); for (var i = 0; i < arr.length; i++) { (function (index) { var url = "https://m.bdocx.com/header.aspx"; $.get(url + "?t=" + (new Date()).valueOf(), function (d) { try { arr.eq(index).empty().html(d); } catch (e) { } try { arr.html(d); } catch (e) { } }); })(i); } }); </script> <script src="https://mstatic.bdocx.com/js/jquery.lazyload.js"></script> <script charset="utf-8"> $("img.lazys").lazyload({ threshold: 200, effect: "fadeIn" }); </script> </body> </html>