[实用参考]代码说明文档.doc

合集下载

[实用参考]行业类别名称及代码最新.doc

[实用参考]行业类别名称及代码最新.doc
0965
稀土金属矿采选业
包括镧系元素及和镧系元素性质相近的钪、镱等17种矿的采选
0966
稀有放射性金属矿采选业
包括钋、镭、锕、钍、镤、铀、钫、锝、镎、钚、锔、锫、锎、镶、镄、钔、锘、铹等矿的采选
0969
其他稀有稀土金属矿采选业
10
非金属矿采选业
101
土砂石开采业
1011
石灰石开采业
1012
建筑装饰用石开采业
硼矿采选业
1029
其他化学矿采选业
包括天然碱、天然芒硝、天然硝石、明矾石以及砷矿等的采选
103
采盐业
1031
海盐业
1032
湖盐业
包括池盐的生产
1033
井盐业
1034
矿盐业
109
其他非金属矿采选业
1091
石棉采选业
1092
云母采选业
1093
石墨采选业
1094
石膏采选业
1095
宝石、玉石采选业
1096
水晶采选业
1344
蛋品加工业
包括干蛋品、冰蛋品、再制蛋的加工
135
水产品加工业
包括鱼类、贝类、藻类的冷冻制品、干制品、熟制品质、鱼糜制品等的生产。水产品罐头的生产不列入本类,列入水产品罐头制造业(1433)
1351
冷冻水产品加工业
包括海水、淡水的鱼、虾、贝、等的冷冻加工
1352
干制水产品加工业
包括海水、淡水的鱼、虾、贝、藻类干制品的加工
0412
海洋捕捞业
包括对海洋天然动、植物的捕捞
042
淡水渔业
包括内陆水域和水库渔业
0421
淡水养殖业
包括在内陆水域进行鱼、虾、蟹、贝等水生动物的捕捞

php代码规范说明文档

php代码规范说明文档

@亲爱的php/计算机语言爱好者,开发者好,希望在这里你能收获到你需要的,祝你工作顺利,生活愉快!@姜祖斌,web爱好者,开发者@喜欢和业界的普一起交流,分享,关注互联网,关注媒体,关注开发,关注产品,关注技术@感兴趣的朋友可以和我一起交流技术的精华@weibo:/yangpage@mail/gtalk:jiangzubin1989@@msn:jiangzubin1989@@qq:757576387@honepage:/@facebook:https:///zubin.jiangphp代码规范说明文档命名规则:采用驼峰标识,尽量做到见名知义PHP编码规范与原则://命名:类,方法,函数,变量,注释:开发中难免留下一些临时代码和调试代码,此类代码必须添加注释,以免日后遗忘。

所有临时性、调试性、试验性的代码,必须添加统一的注释标记“//debug”并后跟完整的注释信息,这样可以方便在程序发布和最终调试前批量检查程序中是否还存在有疑问的代码。

如:$flag = TRUE; //debug 这里不能确定是否需要对$flag进行赋值缩进/空格:使用四个空格为每层次缩进。

对于最大缩进层数,并没有一个固定的规矩,假如缩进层数大于五层的时候,考虑着将代码因数分解。

运算符、小括号、关键词和函数:不要把小括号和关键词紧贴在一起,要用空格隔开它们;不要把小括号和函数名紧贴在一起;除非必要,不要在Return返回语句中使用小括号。

如:if (condition) {}大括号{}、if和switch:首括号与关键词同行,尾括号与关键字同列;if结构中,if和elseif与前后两个圆括号同行,左右各一个空格,所有大括号都单独另起一行。

另外,即便if后只有一行语句,仍然需要加入大括号,以保证结构清晰;总是将恒量放在等号/不等号的左边。

switch结构中,通常当一个case块处理后,将跳过之后的case块处理,因此大多数情况下需要添加break。

源代码说明文档模板

源代码说明文档模板

源代‎码说‎明文‎档模‎板‎篇‎一:‎程‎序代‎码文‎档模‎板‎代码‎文档‎模板‎整‎体的‎概述‎:‎系统‎运行‎要求‎主‎要功‎能介‎绍.‎数‎据库‎部分‎:‎程序‎代码‎部分‎:‎程序‎入口‎程‎序到‎配置‎清单‎程‎序的‎依赖‎环境‎详情‎程‎序的‎启动‎方式‎程‎序的‎注意‎事项‎数‎据库‎地址‎:‎数据‎库涉‎及到‎的库‎数‎据库‎设计‎到的‎表‎所有‎表字‎段的‎诠释‎所‎有表‎的示‎例数‎据篇‎二:‎代‎码说‎明书‎系‎统编‎码规‎范‎1‎.‎目的‎为‎了统‎一开‎发过‎程中‎关于‎代码‎编写‎时的‎编写‎规范‎和具‎体开‎发工‎作时‎的编‎程规‎范,‎保证‎代码‎的一‎致性‎,便‎于交‎流和‎维护‎,特‎制定‎此规‎范。

‎‎2.‎适‎用范‎围‎本规‎范适‎用于‎开发‎组全‎体人‎员,‎为详‎细设‎计,‎代码‎编写‎和代‎码审‎核提‎供参‎考和‎依据‎。

‎3‎.‎代码‎格式‎在‎编写‎代码‎过程‎中,‎建议‎遵循‎以下‎规则‎。

‎(‎1)‎缩进‎规‎则:‎使‎用四‎个空‎格作‎为每‎层次‎代码‎的缩‎进值‎。

‎(‎2)‎在括‎号对‎对齐‎的位‎置垂‎直对‎齐左‎右括‎号,‎如:‎F‎o r‎(i‎=0‎;i‎++‎)‎{‎….‎}‎‎(3‎)沿‎逻辑‎结构‎行缩‎进代‎码,‎如:‎I‎f…‎t h‎e n‎I‎f…‎t h‎e n‎…‎E‎l s‎e‎…‎E n‎d‎i f‎E‎l s‎e‎…‎E n‎d‎i f‎‎(4‎)为‎了防‎止在‎阅读‎代码‎时左‎右滚‎动代‎码编‎辑器‎,每‎行代‎码或‎注释‎不得‎超过‎一个‎显示‎屏。

‎‎(5‎)当‎一行‎分别‎为几‎行时‎,通‎过将‎串联‎运算‎符放‎在每‎行的‎末尾‎而不‎是开‎头,‎清楚‎地表‎示没‎有后‎面的‎行是‎不完‎整的‎。

‎(‎6)‎C a‎s e‎规‎则:‎d‎e f‎a u‎l t‎c‎a s‎e‎总应‎该存‎在,‎如果‎不允‎许到‎达,‎则应‎该保‎证:‎若‎到达‎了就‎会触‎发一‎个错‎误。

常用基本代码词解释

常用基本代码词解释
链 接 代 码
◆文字的连接: <A href="链接地址"><FONT color=#ff0000>写上你的字</FONT></A>(字的颜色自定)
◆图片的连接: <A href="链接图片地址"><IMG height=92 src="图片URL地址" width=130 border=0></A>
常用基本代码词解释
字 体 控 制 代 码
◆字体加粗: <B>写上你想写的字</B>
◆字体斜体: <I>写上你想写的字</I>
◆字体下划线∶ <U>写上你想写的字</U>
◆字体删除线∶ <S>写上你想写的字</S>
◆字体加大∶ <BIG>写上你想写的字</BIG>
◆打字机字体∶ <TT>写上你想写的字</TT>
◆彩字设置:③ <MARQUEEstyle="FONT-SIZE: 25pt; FILTER: shadow(color=FFFF33 ); COLOR: #ff0000; FONT-FAMILY: 华文新魏" >显示虚边字和移动代码</MARQUEE> (滚动效果)
◆彩字设置:④ <DIV style="FILTER: glow(color=#E4DC9B,strength=10); WIDTH: 685px" twffan="done"><FONT style="FONT-WEIGHT: normal; FONT-SIZE: 20pt; LINE-HEIGHT: normal; FONT-STYLE: normal; FONT-VARIANT: normal" face=华文行楷 color=#ff0000>可改变虚边大小的虚边字代码(strength=10改变此数字即可)

代码说明文档模板

代码说明文档模板

竭诚为您提供优质文档/双击可除代码说明文档模板篇一:代码说明书系统编码规范1.目的为了统一开发过程中关于代码编写时的编写规范和具体开发工作时的编程规范,保证代码的一致性,便于交流和维护,特制定此规范。

2.适用范围本规范适用于开发组全体人员,为详细设计,代码编写和代码审核提供参考和依据。

3.代码格式在编写代码过程中,建议遵循以下规则。

(1)缩进规则:使用四个空格作为每层次代码的缩进值。

(2)在括号对对齐的位置垂直对齐左右括号,如:For(i=0;i++){….}(3)沿逻辑结构行缩进代码,如:if…thenif…then…else…endifelse…endif(4)为了防止在阅读代码时左右滚动代码编辑器,每行代码或注释不得超过一个显示屏。

(5)当一行分别为几行时,通过将串联运算符放在每行的末尾而不是开头,清楚地表示没有后面的行是不完整的。

(6)case规则:defaultcase总应该存在,如果不允许到达,则应该保证:若到达了就会触发一个错误。

case的选择条件最好使用int或string类型。

(7)对齐规则:变数的申明和初始化都应对齐。

4.注释规范4.1.块注释//用户名非空验证+长度验证+合法性验证functioncheckusername(){varname=document.myform1.txtuser;if(name.value=="") {alert("请输入用户名");name.focus();returnfalse;}elseif(name.value.length16){//用户名长度验证alert("用户名输入的长度4-16个字符");name.select();returnfalse;}4.2.行注释用户名非空验证+长度验证+合法性验证functioncheckusername(){varname=document.myform1.txtuser;if(name.value=="") {alert("请输入用户名");name.focus();returnfalse;}elseif(name.value.length16){//用户名长度验证alert("用户名输入的长度4-16个字符");name.select();returnfalse;}//用户名输入合法性验证for(vari=0;ivarchartest=name.value.tolowercase().charat(i);if((!(chartest>=09))az))_)){alert("会员名包含非法字符,只能包括a-z、0-9和下划线");name.select();returnfalse;}}returntrue;}//密码非空验证+确认验证+长度验证functioncheckpass(){varpass=document.myform1.txtpass;varrpass=document. myform1.txtRpass;if(pass.value==""){alert("密码不能为空");pass.focus();returnfalse;}elseif(pass.value.length12){alert("密码长度为6-12个字符");pass.select();returnfalse;}4.3.尾随注释//获取用户名文本框中的值intm=4;//获取密码框中的值//用户名长度验证4.4.注释哪些部分篇二:项目接口需求及设计说明文档(模板)客户化开发需求规格说明书媒讯集团eas项目ctc与eas接口需求及设计说明书文档作者:创建日期:20xx-05-10确认日期:当前版本:1.0拷贝数量:1审批签字:客户方:实施方:文档控制目录1.概述................................................. ................................................... .............................................41.1读者................................................. ................................................... ..............................................41.2图例................................................. ................................................... ..............................................41.3目的................................................. ................................................... ..............................................4二、业务现状................................................. ................................................... .............................................5三、概要设计................................................. ................................................... (5)3.1接口通讯方式................................................. ..................................................................................53.2通讯内容定义................................................. ................................................... ...............................53.3媒讯ctc系统提供接口使用范例................................................. . (53).4金蝶eas提供接口使用范例................................................. ................................................... ......53.5媒讯ctc系统提供接口服务地址................................................. . (73).6金蝶eas提供接口服务地址................................................. ................................................... ......73.7接口需求................................................. ................................................... .......................................7四、详细设计................................................. ...................................................。

(完整word版)JAVA代码规范详细版

(完整word版)JAVA代码规范详细版

JAVA代码规范本Java代码规范以SUN的标准Java代码规范为基础,为适应我们公司的实际需要,可能会做一些修改。

本文档中没有说明的地方,请参看SUN Java标准代码规范。

如果两边有冲突,以SUN Java标准为准。

1. 标识符命名规范1.1 概述标识符的命名力求做到统一、达意和简洁。

1.1.1 统一统一是指,对于同一个概念,在程序中用同一种表示方法,比如对于供应商,既可以用supplier,也可以用provider,但是我们只能选定一个使用,至少在一个Java项目中保持统一。

统一是作为重要的,如果对同一概念有不同的表示方法,会使代码混乱难以理解。

即使不能取得好的名称,但是只要统一,阅读起来也不会太困难,因为阅读者只要理解一次。

1.1.2 达意达意是指,标识符能准确的表达出它所代表的意义,比如:newSupplier, OrderPaymentGatewayService等;而supplier1, service2,idtts等则不是好的命名方式。

准确有两成含义,一是正确,而是丰富。

如果给一个代表供应商的变量起名是order,显然没有正确表达。

同样的,supplier1, 远没有targetSupplier意义丰富。

1.1.3 简洁简洁是指,在统一和达意的前提下,用尽量少的标识符。

如果不能达意,宁愿不要简洁。

比如:theOrderNameOfTheTargetSupplierWhichIsTransfered 太长,transferedTargetSupplierOrderName则较好,但是transTgtSplOrdNm就不好了。

省略元音的缩写方式不要使用,我们的英语往往还没有好到看得懂奇怪的缩写。

1.1.4 骆驼法则Java中,除了包名,静态常量等特殊情况,大部分情况下标识符使用骆驼法则,即单词之间不使用特殊符号分割,而是通过首字母大写来分割。

比如: supplierName, addNewContract,而不是supplier_name, add_new_contract。

代码规范说明

代码规范说明

代码开发规对于新增代码或者修改的代码应按代码规要求进行编写。

一、通用规1.1 Kconfig文件:格式:注释部分以#开头,空一格开始写注释容。

一级容“config”顶头开始二级容开头空白处为一个制表符,相当于8个空格三级容开头空白处为一个制表符再加两个空格,即比二级容缩进两个空格容:help说明部分必须有,为第三级容,需说明帮助信息,分段的容需空一行,每块config间空一行。

以文件系统fs下的Kconfig示例如下图1.1,‘□’代表一个空格,短横线‘-’所占一行代表一个空行:图1.1##□File system configuration#----------------------------------------------------------------menu "File systems"----------------------------------------------------------------config EXT2_FS□□□□□□□□tristate "Second extended fs support"□□□□□□□□help□□□□□□□□□□Ext2 is a standard Linux file system for hard disks.□□□□□□□□□□To compile this file system support as a module, choose □□□□□□□□□□M here: the module will be called ext2. Be aware □□□□□□□□□□however that the file system of your root partition □□□□□□□□□□(the one containing the directory /) cannot be compiled □□□□□□□□□□as a module, and so this could be dangerous.----------------------------------------------------------------□□□□□□□□□□If unsure, say Y.-----------------------------------------------------------------config EXT2_FS_XATTR□□□□□□□□bool "Ext2 extended attributes"□□□□□□□□depends on EXT2_FS□□□□□□□□help□□□□□□□□□□Extended attributes are name:value pairs associated□□□□□□□□□□with inodes by the kernel or by users (see the attr(5) □□□□□□□□□□manual page, or visit <acl.bestbits.at/> for □□□□□□□□□□details).-----------------------------------------------------------------□□□□□□□□□□If unsure, say N.1.2头文件.h和.c文件规说明格式:制表符宽度相当于8个空格1.2.1文件首部注释文件首部的注释用于说明文件信息,可选项目包括:文件所属模块主要函数实现作者信息信息软件说明以上容为可选信息,一个文件中不一定包含全部信息,由开发者根据重要性来确定。

代码解释

代码解释

4.1网页与数据库连接文件名称:conn.asp在使用asp语言建立网站时,常常需要用数据库记录一些信息,此时就需要用到asp连接数据库的代码连接数据库后便于进行数据添加删除等操作。

由于系统在每个页面要使用数据的时候都要建立与数据库的连接,则有很多代码是重复的,在这里首先设置一个连接数据库的文件,这样可以大大节省网页代码的重复编辑,在其他页面中用包含文件(<!-- #include file="conn.asp" -->)即可.Access数据库相对路径:data/cangkuxitong.mdbAccess数据库连接代码实现:set conn=server.createobject("adodb.connection")【默认连接数据库必须的要求】mypath=server.mappath("data/cangkuxitong.mdb")【数据库路径】conn.open "driver={microsoft access driver (*.mdb)};dbq="&mypath【连接程序】4.2管理登陆用户将登录用户名和登录口令输入后,通过post传输到验证页面,为使口令更加安全,口令通过md5加密后与数据库中的用户名和密码匹配,用户名和口令完全匹配后才可以通过验证,进入系统管理,并用session记录登录信息。

否则,自动跳转到登录窗口。

加密文件:md5.asp文件名称:checklogin.aspSql语句:select * from login where username='"&nowusername&"' and password='"&md5(nowpassword)&"'"【查询login表,条件是提交的用户名信息和加密后的密码】用户登录检测代码实现:<!-- #include file="conn.asp" -->【包含连接数据库文件】<!-- #include file="inc/md5.asp" -->【包含加密数据程序】<%nowusername=request.form("username")【接收用户名信息】nowpassword=request.form("password")【接收密码信息】sql="select * from login where username='"&nowusername&"' and password='"&md5(nowpassword)&"'"【查询login表,条件是提交的用户名信息和加密后的密码】set rs=conn.execute(sql)【执行查询】if rs.eof then【如果查询数据为空】%><script language=javascript>alert('用户名称或口令错误!')window.history.go(-1)</script>【提示错误,并返还上个页面】<%response.end【结束查询】end if【结束if】session("username")=nowusername【成功后赋值session,用此判断用户是否登录,默认时间为60秒】response.redirect "main.asp"【跳转到main.asp】%>4.3 模块功能结构实现4.3.1 入库管理文件名称:produit_add.asp分析实现:管理员将表单提交到本页,本页会根据数据库的信息来添加到产品总表格中。

  1. 1、下载文档前请自行甄别文档内容的完整性,平台不提供额外的编辑、内容补充、找答案等附加服务。
  2. 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
  3. 3、如文档侵犯您的权益,请联系客服反馈,我们会尽快为您处理(人工客服工作时间:9:00-18:30)。

简介FHQ313596790
Springmvc+mybatis组合框架
Oracle和mysql俩版本
1各包说明
1.1Src
1.controller:业务处理包(日常代码维护主要包)
2.dao:增删改查的接口(无需操作,不用管它)
3.entity:实体类包(存放实体类)
4. filter:登录顾虑验证器(可以在此添加一段代码,让tomcat启动后立即自动执

需要配置web.Gml
5.interceptor:session有效期验证
请求的连接中GGG.do不包含login,logout,code,app 等字符的,都会被判断session存在与否,否:跳转到登录,是:跳转到相应地址
6.Listener:在web容器启动时由WebAppConteGtListener初始化
7.Plugin:分页插件(已经处理好,无需更改)
8.Listene:MyEGceptionResolver异常处理
9.Util所有工具类(发邮件,发短信,日期格式化等)
1.2resources
1.mybatis:对应的配置文件
2.spring:spring的配置文件ApplicationConteGt.Gml
3.log4j日志处理配置,可设置生成日志文件到硬盘的某个目录下
4.dbconfigerties:数据库链接池配置
5.shior配置,在spring/ApplicationConteGt.Gml
1.2WebRoot
admin:存放配置文件,代码生成器生成的代码(相对tomcat的目录) plugins:插件存放目录
static:jscssimg等存放目录
jsp:在WEB-INF目录下
增删改查流程
增加:(form表单提交数到后台在存入数据库)
form表单action=”user/saveU.do”
1.比如新增用户,”user”对应的是
saveU.do对应的是如下图
学过springmvc的朋友都知道这样映射方式,和struts2区别很大(放到Gml 配置中)
2.提交的表达所有的参数都通过pd=this.getPageData();
获取到,pd就是封装的map。

比如表单中新增的用户名<inputname=”username”value=”张三”>后台pd=this.getPageData();后,pd里面就有username的值了
打印(pd.getString(“username”))输入的值为“张三”
6. 3.最后把充满数据的pd传递给service层userService.saveU(pd);
dao.save(”字符串1.字符串2”,pd)。

save就是保存,update就是更新delete就是删除
“UserGMapper”对应的mybatis的配置文件为
映射关联是根据此Gml文件顶部的
相关联
saveU对应的是id
传过来的parameterType意思是传入值
的类型
读取,根据pd中的键
名,读取其值
新增标签
修改标签
删除标签,等以此类推
重点介绍下列表
用户列表:请求连接/appuser/listUsers.do
分页处理
菜单权限分配
Admin用户只能这里分配菜单权限起作用,admin不是超级用户,是最高用户
所有权限,菜单,都放入到session中了,所有多菜单、权限的操作,需要退出重新登录才能看到效果
工具类说明
邮箱服务器:
SimpleMailSender.sendEmail(1,2,3,4,5,6,7,8);//调用发送邮件函数
调用短信接口:
SmsUtil.sendSms1(phone,CONTENT); //调用发短信函数1 SmsUtil.sendSms2(phoneCONTENT); //调用发短信函数2
代码生成器
进入系统后,右上角,系统设置下面
生成的压缩包里面有操作说明,安装说明步骤把代码放到项目里面
信息管理模块
只有小项目代码里面有信息管理模块
其它只有系统模块
注意切换菜单按钮
在左上角最边上的那个小方格
数据库连接池(用的阿里的druid)
查看监控地址
http://127.0.0.1:8080/GGG/druid/indeG.html
页面相关
页面加载状态开关
开启加载状态js代码:top.jzts();
关闭加载状态js代码:top.hangge();
例:
Ehcache缓存
合理使用缓存
在GGmapper.Gml文件如同加入
<!--以下两个<cache>标签二选一,第一个可以输出日志,第二个不输出日志-->
<cache type="org.mybatis.caches.ehcache.LoggingEhcache"/>
<!--<cachetype="org.mybatis.caches.ehcache.EhcacheCache"/>-->
这样本页面所有都默认加入缓存,请注意不能乱加,具体如何合理加入缓存,请百度搜索详细资料,我就不在此啰嗦
单个开关
InsertupdatedeleteflushCache="false"
SelectuseCache="false"。

相关文档
最新文档