当前位置：文档之家 › [实用参考]代码说明文档.docx

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

  • 格式：docx
  • 大小：606.26 KB
  • 文档页数：7

[重点实用参考文档资料]
[重点实用参考文档资料]
简介FHQ313596790
Springmvc+mybatis组合框架
Oracle和mysql俩版本
1各包说明
1.1 Src

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.2 WebRoot
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。
比如表单中新增的用户名三”>
后台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文件如同加入


这样本页面所有都默认加入缓存，请注意不能乱加，具体如何合理加入缓存，请
百度搜索详细资料，我就不在此啰嗦
[重点实用参考文档资料]
[重点实用参考文档资料]
单个开关
InsertupdatedeleteflushCache=
"false"
SelectuseCache=
"false"

合集下载

网页代码文档

网页代码文档

网页代码1. 简介网页代码是指用于构建网页的一系列指令和标记。

它使用HTML（Hypertext Markup Language）和CSS（Cascading Style Sheets）等语言来描述和布局网页的内容、结构和外观。

在这篇文档中，我们将介绍网页代码的一些基本知识和常见的用法，以帮助你开始构建自己的网页。

2. HTMLHTML是网页代码的基础，它通过使用一系列的标签来定义网页的结构和内容。

以下是一些常见的HTML标签及其用法：•<html>：定义HTML文档的根元素。

•<head>：定义文档的头部，包含了一些网页的元数据和其他重要的信息。

•<body>：定义文档的主体，包含了网页的可见内容。

1•<h1>到<h6>：定义标题，从大到小依次减小。

•<p>：定义段落。

•<a>：定义超链接。

除了以上标签，HTML还有很多其他的标签可用于定义列表、表格、图像等内容。

HTML标签通常是成对出现的，一个是开始标签，一个是结束标签。

例如，<p>开始一个段落，</p>结束一个段落。

3. CSSCSS用于控制网页的外观和样式。

它通过选择器和属性来指定网页元素的样式。

以下是一些常见的CSS属性：•color：定义文本颜色。

•background-color：定义背景颜色。

•font-size：定义字体大小。

•text-align：定义文本对齐方式。

•margin：定义元素的外边距。

2•padding：定义元素的内边距。

CSS选择器用于选择需要应用样式的HTML元素。

以下是一些常见的CSS选择器：•元素选择器：选择指定元素类型的元素，例如p选择所有<p>元素。

•类选择器：选择具有指定类的元素，例如.red选择所有拥有red类的元素。

•ID选择器：选择具有指定ID的元素，例如#header选择拥有header ID的元素。

代码文档规范范本

代码文档规范范本

代码文档规范范本一、引言本文档是为了规范化编写和管理代码文档而制定的，旨在提高代码文档的质量和可读性，方便团队成员之间的协作与交流。

本文档适用于所有项目的代码文档编写，包括但不限于需求文档、设计文档、接□文档等。

二、文档命名规范为了便于管理和查找，所有的代码文档都需要按照以下规范进行命名：1.使用有意义的文件名，能够清晰表达文档的用途和内容。

2.文件名使用小写字母，单词间可以使用下划线进行分隔。

3.文件名必须以文档类型作为后缀，例如.doc、.Pdf、.md等。

三、文档结构规范为了使代码文档易于阅读和理解，文档的结构应该清晰，并且内容组织合理。

以下是常见的文档结构示范：1.引言：对文档的目的、范围和主要读者进行简要说明。

2.背景：描述项目背景和相关环境信息。

3.功能描述：详细介绍项目的功能需求，包括用户需求和系统需求。

4.设计方案：针对每个功能需求提供相应的设计方案，包括系统架构、模块划分、数据结构等。

5.接口定义：定义与外部系统或模块的接口规范，包括输入输出参数、数据格式等。

6.数据库设计：描述数据库结构、表的设计以及数据字典等。

7.测试方案：说明对代码进行的测试方法和策略，包括单元测试、集成测试等。

8.部署说明：描述代码的部署方式和环境要求。

9.附录：包括其他相关的补充信息，如术语表、参考资料等。

四、文档编写规范1.正文内容应简明扼要，字数不宜过多或过少。

2.使用简洁、明确的语言，避免使用俚语、口语或技术术语过多。

3.遵循统一的命名规范，包括函数名、变量名、类名等。

4.提供必要的注释，解释代码的意图、实现方法或注意事项。

5.确保文档的逻辑性和连贯性，段落之间应具有一定的过渡和衔接。

6.针对不同的文档类型，采用相应的文档模板和结构，如需求规格说明书、接口设计文档等。

7.使用合适的文档编辑工具，确保文档的格式统一、排版美观。

五、文档更新与版本管理为保持文档的实时性和准确性，在文档编写过程中需要及时更新和维护文档。

代码规范说明

代码规范说明

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

一、通用规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文件首部注释文件首部的注释用于说明文件信息，可选项目包括：文件所属模块主要函数实现作者信息信息软件说明以上容为可选信息，一个文件中不一定包含全部信息，由开发者根据重要性来确定。

代码检查规则介绍(doc 7页)(推荐免费下载版)

代码检查规则介绍(doc 7页)(推荐免费下载版)

1.命名规范2.JavaDoc注释类和接口的JavaDoc方法的JavaDoc变量的JavaDoc3.长度限制文件长度：Java文件的行数不能超过某个值，默认值是1500每行长度：每行的字母个数不能超过某个值，默认值是120方法长度：方法的行数不能超过某个值，默认值是150方法的参数个数：方法参数的个数不能超过某个值，默认值是7return 语句的数量：方法中return语句的个数不能超过某个值，默认值是24.重复的代码检查内容重复的代码：当相同代码的行数超过某个值时，就认为是重复的代码，默认值是15 5.多余的不必要的括号{}不必要的圆括号：检查不必要的圆括号”(,)”。

例如：if(((((true)))))6.未简化的未被简化的条件表达式：检查过度复杂的条件表达式，例如：(b == true)，b || true，!false未被简化的布尔返回值：检查未被简化的boolean返回语句，例如：可以简化成：7.空白区域(empty block)检查{}包含起来的区域是否为空8.空语句(empty statement)检查是否有空的语句;9.比较equals和hashCode方法：检查一个类是否同时重写了equals和hashCode方法子类在重写hashCode()方法时，要调用父类的hashCode()在实现equals()方法时要使用instanceof操作符要把常量放在equals()方法的左边，例如：“hello”.equals(s)，而不是s.equals(“hello”)使用equals()比较对象的引用，而不要使用==或!=10.switch为switch语句提供default标签switch语句的default应该放在最后检查case中是否有break，return ，throw 或continue语句，确保每次switch只执行一个分支11.Exception限制try-catch 的嵌套层次，默认值是3不允许throws某些异常，例如：ng.Exception、ng.Error、ng.RuntimeException和your.package.Exception 等从catch语句中抛出一个新的异常时，没有把原来的异常传入新异常中，会导致异常跟踪信息的丢失(把异常作为参数传入自定义的异常处理类)在当前catch语句中, 处理被捕获的异常（记录异常；抛出新的异常；处理异常）, （项目组：不管有没有进行处理，一定要再次throw出去，重点是指调用平台的异常，不要自己吞下去，以方便平台组用来解决问题）不要捕获NullPointerException，因为捕获了之后会把这个异常屏蔽，可能会引起后续抛出很难分辨的异常开发人员不要抛出NullPointerException，因为大家通常会认为这个异常是JVM抛出的，考虑用IllegalArgumentException代替，这样会更清晰，更像是开发人员发起的异常不要从finally语句返回值1.对Java的异常类的使用：●不允许使用RuntimeException等无法通过类名反应出异常产生原因的异常类●其它如IllegalArgumentException、ClassCastException等能反应出异常原因的异常类也建议再封装成模块自定义的异常类2.异常类体系3.合理使用Checked Exception和Runtime Exception：●如果提供的api能通过捕获的异常处理保证系统的正常运转，建议抛出Checked Exception●大部分情况都是使用Runtime Exception4.对外发布为Runtime Exception不能修改为Checked Exception，可能造成用户已有代码出错5.BSP、BPM对外提供的接口必须使用try、catch、throw方式进行日志记录后再转抛，其它核心代码的catch块中建议尽量加入日志记录（如控制器部分），日志使用apache commons logging6.捕获的异常在保证系统能继续正常执行逻辑的前提下，应进行处理，而不要继续throw7.对捕获的异常（catch代码块中）：●如果没有继续throw异常，需加上注释说明不继续throw的原因，同时通过log.warn("处理的异常信息描述。