程序员开发手册
- 格式:doc
- 大小:505.50 KB
- 文档页数:21
Framework架构手册前言本框架基于Struts2.0+Spring2.5+Hibernate3.2架构所建,用于中小型企业网站或管理系统基础架构。
下面先简要介绍一下struts,spring,hibernate●Struts简介Struts是一个基于Sun J2EE平台的MVC框架,主要是采用Servlet和JSP技术来实现的。
Struts把Servlet、JSP、自定义标签和信息资源(message resources)整合到一个统一的框架中,开发人员利用其进行开发时不用再自己编码实现全套MVC模式,极大的节省了时间,所以说Struts是一个非常不错的应用框架。
●Spring简介Spring是一个解决了许多在J2EE开发中常见的问题的强大框架。
Spring提供了管理业务对象的一致方法并且鼓励了注入对接口编程而不是对类编程的良好习惯。
Spring的架构基础是基于使用JavaBean属性的Inversion of Control容器。
然而,这仅仅是完整图景中的一部分:Spring在使用IoC容器作为构建完关注所有架构层的完整解决方案方面是独一无二的。
Spring提供了唯一的数据访问抽象,包括简单和有效率的JDBC框架,极大的改进了效率并且减少了可能的错误。
Spring的数据访问架构还集成了Hibernate和其他O/R mapping解决方案。
Spring还提供了唯一的事务管理抽象,它能够在各种底层事务管理技术,例如JTA 或者JDBC事务提供一个一致的编程模型。
Spring提供了一个用标准Java语言编写的AOP 框架,它给POJOs提供了声明式的事务管理和其他企业事务--如果你需要--还能实现你自己的aspects。
这个框架足够强大,使得应用程序能够抛开EJB的复杂性,同时享受着和传统EJB相关的关键服务。
Spring还提供了可以和IoC容器集成的强大而灵活的MVC Web框架。
●Hibrenate简介Hibernate是一个开放源代码的对象关系映射框架,它对JDBC进行了非常轻量级的对象封装,使得Java程序员可以随心所欲的使用对象编程思维来操纵数据库。
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)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,结构表现行为分离,兼容性优良。
代码要求简洁明了有序,尽可能的减小服务器负载,保证最快的解析速度。
开发时需要遵循如上基本准则,特殊情况可以有所宽限,如一些老项目的页面改造。
三、文件规范2.1文件命名规则[使用场景:在新建网页、图片、脚本、CSS文件时,根据此规则给文件命名并放入指定位置]文件名称统一用小写的英文字母、数字和下划线的组合,其中不得包含汉字空格和特殊字符。
命名原则的指导思想一是使得你自己和工作组的每一个成员能够方便的理解每一个文件的意义,二是当我们在文件夹中使用“按名称排例”的命令时,同一种大类的文件能够排列在一起,以便我们查找、修改、替换、计算负载量等等操作。
8 其它8.1 报表打印在这里,简单说一下报表。
其实据说RPG 设计之初,主要就是为了解决报表问题。
不过发展到现在,在我接触过的系统中,觉得报表在RPG 编程之中反而退居其次,大部分程序都是对数据库中磁盘文件(即PF 文件)的操作。
报表文件其实在某种意义上与普通的磁盘文件很类似,都是有记录格式(Record Format),都可以进行写操作(WRITE),RPGLE 的程序对它们的操作方式也比较雷同。
所不同的是普通的磁盘文件的数据是存储在数据库中,而报表文件WRITE 了之后,是以脱机文件(Spool File)的形式存在。
所以在一个库中,磁盘文件具有唯一性,即不能有同名的磁盘文件;而在同一个输出队列中,同名的报表文件(即生成的脱机文件),允许有多个。
要做一个全新的报表打印,大致上可以分为画报表文件(PRTF),与编写打印程序这两部分。
一、画报表文件(PRTF)1、新建立一个属性为PRTF的文件,然后使用19 进入报表编辑状态。
(即STRRLU)2、定义一个新的记录格式(Record Format):DR + F18 + F10,注意看下方的功能键说明3、在一个记录格式之下,追加内容时,要在新的编辑行前加“CLC”,表示此行的内容,是属于上面记录格式的。
4、编辑行前加:DC:定义常量CF:使当前行的内容居中5、常用功能键:F13:标记/ 取消标记(光标所指的字段)。
多试一下就知道使用方法,可以将同一行的多个相连的字段标记成为一个块(对首尾两个字段操作F13 即可)。
高亮部分表示已被标记的块。
F14:将已标记的块COPY 到光标指定处。
(其实这个我用得不多)F15:将已标记的块MOVE 到光标指定处。
(这个用得不少)F16:删除已标记的块。
(这个用的频率也不少)F11:定义新变量F23:进入当前字段的功能菜单画面6、对新变量的定义,按F11 之后,见到画面如下:Edited length . . . . . . . . . . . . : 1Record format . . . . . . . . . . . . : RCD001Number of keywords . . . . . . . . . : 0Number of indicators . . . . . . . . : 0Type choices, press Enter.Field . . . . . . . . . . . . . . . . FLD001 NameOption indicators . . . . . . . . . . 01-99, N01-N99More indicators . . . . . . . . . . N Y=Yes, N=NoStarting line . . . . . . . . . . . . 1-255Starting position . . . . . . . . . . 6 1-255, +nnLength of data . . . . . . . . . . . 1 1-378, +nn, -nn翻页,还有:Data type . . . . . . . . . . . . . . 1 1=Character2=Zoned3=Floating point4=Open5=Graphic6=Date7=Time8=Time stampDecimal positions . . . . . . . . . . 0-31, +n, -nReference a field . . . . . . . . . . N Y=Yes, N=NoUse referenced values . . . . . . . Y Y=Yes, N=No可以采用直接定义长度、类型的方法,即在第1 页的最末尾,Length of data 处,填上字段长度;如果是字符型,就不需要再填其它内容;如果是数字型,在第2 页Decimal positions 处填上小数位数。
vba汉英手册VBA汉英手册——助力VBA开发作为一名VBA程序员,我们时常需要查阅相关的VBA文档和手册,以便更加顺畅地进行开发。
而本文将介绍一款非常优秀的VBA汉英手册,它可以帮助我们更快速地理解和使用VBA语言。
一、“VBA汉英手册”是什么?VBA汉英手册是一款将VBA官方文档进行翻译和整理的工具,它可以将VBA函数、对象、方法等内容翻译成中文,极大地方便了国内的VBA程序员查阅。
二、使用VBA汉英手册的好处1、提高开发效率由于VBA汉英手册将英文的VBA函数、对象、方法等翻译成了中文,我们可以更加迅速地理解这些内容,提高开发效率。
2、便于学习对于刚学习VBA的程序员来说,VBA汉英手册是一款非常好的学习工具。
它可以帮助我们快速地掌握VBA语言的知识点和用法,提高我们的学习效率。
3、解决语言障碍对于一些英语不好的程序员来说,阅读VBA官方文档可能会遇到一定的困难。
而使用VBA汉英手册可以帮助我们解决语言障碍,轻松阅读VBA官方文档。
三、如何使用VBA汉英手册1、安装VBA汉英手册VBA汉英手册可以在官方网站上进行免费下载。
我们只需要在浏览器中访问官方网站,下载其安装包,并进行安装即可。
2、使用VBA汉英手册VBA汉英手册包含了丰富的VBA内容,我们只需要在搜索框中输入我们要查找的VBA函数、对象、方法等,就可以得到相应的中英文翻译。
四、总结VBA汉英手册是一款非常好的VBA学习和开发工具,它可以帮助我们更加方便地查阅VBA官方文档,提高开发效率,解决语言障碍,帮助我们更加深入地了解VBA语言。
因此,作为一名VBA程序员,我们一定要学会使用VBA汉英手册。
阿里开发者手册阿里开发者手册是阿里巴巴公司面向全球开发者发布的一系列文档和规范,旨在提高软件开发行业的规范性和质量。
该手册包括了软件开发、测试、部署等方面的最佳实践和规范,可帮助开发者更好地设计、编写和维护软件系统。
阿里开发者手册主要包含以下内容:**一. Java开发手册**Java开发手册详细说明了Java编程中的最佳实践和规范。
其包含的内容涵盖了Java开发的方方面面,如代码风格、异常处理、日志记录、注释、JVM参数调优等等。
Java开发手册被广泛认可,并已成为Java 开发行业的标准。
**二. 前端开发手册**前端开发手册是从前端工程师角度出发,为开发者提供了CSS、JavaScript、浏览器兼容性和网站性能优化等细节方面的最佳实践和规范。
前端开发手册提供了前端开发过程中必要的规范,能够提高代码的可读性及维护性。
**三. 微服务开发手册**微服务开发手册提供一组优秀的微服务设计原则,可以帮助开发者在使用微服务时降低系统的复杂度,提高系统的可伸缩性和可维护性。
该手册重点讲解了微服务架构中的最佳实践和规范,涵盖了微服务的架构、开发、部署和运维等方面。
**四. 安全开发手册**安全开发手册为开发者提供一系列的最佳实践和规范,帮助开发者在软件开发中重视信息和网络安全,避免因不恰当的代码和部署措施而导致的数据泄漏和系统崩溃等问题。
本手册涵盖即时通讯、网页安全、API等方面的安全问题,内容翔实且易懂。
**五. 数据库开发手册**数据库开发手册包含了数据库设计、应用程序处理的最佳实践和规范。
其中包括SQL编程、事务控制、数据模型设计与规范等方面的内容。
该手册提供了完整的数据库开发方法,使得开发者能更好的处理数据库方面的问题。
总的来说,阿里开发者手册是针对软件开发行业的严苛要求而编制的一系列规范和制度。
阅读手册有助于开发者了解行业的最新动态和发展趋势,有利于开发者规范化和优化自己的开发方式和技能。
图1-1Visual C++界面开项目工作区文件时其他文件随即会自动打开。
在此文件夹下还会创建 Res(资源)、Debug(调试)、Release(发行)等子文件夹。
2.2编辑 在编辑窗口打开、浏览文件、输入、修改、复制、剪切、粘贴、查找、替换、撤销等操作,可以通过菜单完成,也可以通过工具栏按钮完成,这些与 Word 之类的 windows 编辑器用法完全相同,这里就不再重复叙述了。
2.3辅助VC 不仅提供了“语法着色”帮助我们阅读程序,还可以通过一些快捷键检查常见的括号不匹配错误。
MSDN 也可以在编辑过程中提示存在的变量名、函数名。
很多程序员借助类似 Visual Assist X 的工具辅助开发,减少程序出错的可能性。
3.开发 C 程序3.1开发单个 C 语言程序1. 创建一个工作文件夹。
由于开发过程会产生一系列文件,建议每开发一个新的 C 程序都创建一个工作文件夹。
还可以将所有工作文件夹集中到一起,如E:\LXH\EX01-01 、E:\LXH\EX03-02 等。
2. 启动 Visual C++。
3. 新建一个 C 语言源程序。
选择菜单:File 下的 New 菜单项,出现如图 1-2 所示 new(新建)对话框。
图1-2选择菜单File下的New菜单项选择 Files标签下的 C++Source File 在“E:\LXH\EG01-01”文件夹中创建C 程序:eg01-01.c,如图 1-3 所示。
图1-3Files标签4. 输入、编辑源程序。
注意不要输入中文标点符号,要及时按 Ctrl+S 保存文件,如图 1-4 所示。
图1-4输入源程序5.编译、连接。
点击“BuildMiniBar”工具栏上的“Build”按钮进行编译、连接。
也可以选择菜单 Build 下的 Build (F7) 菜单项或Rebuild All菜单项。
更简捷的方法是直接按 F7 功能键。
Visual C++将提示创建默认工作区,如图 1-5 所示。
6.EAI开发6.1. 概述6.1.1.EAI产品简介U8企业应用集成(EAI)产品是U8ERP与第三方系统进行业务数据交换的平台级工具产品,是U8ERP统一的对外开放接口。
EAI产品包括一整套U8ERP的标准业务数据交换接口,这些接口涵盖基础档案、财务、供应链、生产制造、客户关系管理、HR等ERP业务模块,具备统一的入口、一致的业务外观和相对完整的业务功能,能完成U8基础数据、凭证、业务单据的导入导出及增、删、改等操作(少数不支持),是U8与外部系统进行应用集成和业务整合的基本资源。
在技术上,EAI数据交换接口采用符合业界标准的XML作为数据交换接口规范(协议)描述,充分利用了XML跨平台和低耦合的特性。
基于XML的交换协议描述了数据交换过程中Request/Response消息数据格式及元数据规范(Schema),外部系统只要遵循此标准和规范即可以方便的与U8ERP进行Talking。
6.1.2.EAI产品结构U8企业应用集成(EAI)产品结构自下而上分为三层:数据交换基本资源层、EAI数据交换框架层、EAI工具层。
6.1.2.1.数据交换基本资源层即U8ERP基础数据交换接口层,这一层包含U8ERP各业务模块所提供的以业务数据实体(档案、单据、凭证等)导入导出为核心任务的基础业务接口,涵盖了U8ERP的核心业务功能点。
这些业务接口通过EAI数据交换框架层对外开放并公布,为外部系统访问U8提供了最基础的功能支持。
这些原始业务接口属于U8内部功能,只能通过EAI数据交换接口统一访问,外界不能直接使用。
6.1.2.2.EAI数据交换框架层EAI数据交换框架层统一封装了底层的U8ERP的数据交换业务接口;对外公布了U8的所有数据交换服务;为外部系统访问U8提供了统一的访问途径和一致的调用入口(Broker /Proxy)。
其中,通过一套标准的档案和单据元数据模板(Schema),提供了U8的业务数据接口外观,描述了数据交换的应用协议(交换格式、上下文),为外部系统访问U8提供了详细完整的接口规范。
《安全生产信息化管理系统》 程序员开发手册 1概述 目的 1、方便代码的交流和维护。 2、不影响编码的效率,不与大众习惯冲突。 3、使代码更美观、阅读更方便。 4、使代码的逻辑更清晰、更易于理解。 范围 本手册适用于开发部全体人员,作用于软件项目开发的代码编写阶段和后期维护阶段。 警示 通过自动检查【】或人工检查【部门主管或相关负责人】不符合编码规范的,必须在限期【部门主管或相关负责人指定时间】内修正,逾期视为工作过失,部门主管或相关负责人视具体情况做出相关处理。 术语定义 1、匈牙利命名法【禁用】 标识符的名字以一个或者多个小写字母开头作为前缀;前缀之后的是首字母大写的一个单词或多个单词组合,该单词要指明变量的用途。 例如:aUserId 数组 (Array)定义以小写字母a开头 2、帕斯卡(pascal)命名法【推荐】 将标识符的首字母和后面连接的每个单词的首字母都大写。可以对三字符或更多字符的标识符使用Pascal 大小写。例如:UserId 3、骆驼(Camel)命名法【推荐】 标识符的首字母小写,而每个后面连接的单词的首字母都大写。例如: userId 2代码格式 列宽 1、为了防止在阅读代码时不得不滚动源代码编辑器,每行代码或注释在一般显示频率下不得超过一显示屏,代码列宽控制在110字符左右。 2、系统中部分代码可以不遵循此原则。 如:VIWFormItemDetail[] dv = (VIWFormItemDetail[]) , sqlParams); 3、SQL语句拼接、字符串拼接、函数参数名过长、判断语句过长的代码要遵循以上原则。 换行 1、当表达式超出或即将超出规定的列宽,一行被分为几行时,通过将串联运算符放在每一行的末尾而不是开头,清楚地表示没有后面的行是不完整的。 String querySql = “ SELECT ProjectId”+“,ProjectTitle ”+“FROM Project ” 2、每一行上放置的语句避免超过一条。 3、当表达式超出或即将超出规定的列宽,遵循以下规则进行换行 (1)在逗号前换行。 (2)在操作符前换行。 (3)规则1优先于规则2。 例如: StringBuilder querySql = new StringBuilder(); ("SELECT AS PK "); (","); (","); (", AS ISBNCode"); ("FROM Project a "); 当以上规则会导致代码混乱的时候自己采取更灵活的换行规则。
缩进 缩进应该是每行一个Tab(4个空格),不要在代码中使用Tab字符。 Visual 设置:工具->选项->文本编辑器->C#->制表符->插入空格 空行 空行是为了将逻辑上相关联的代码分块,以便提高代码的可阅读性。 在以下情况下使用两个空行 1、接口和类的定义之间。 2、枚举和类的定义之间。 3、类与类的定义之间。
在以下情况下使用一个空行 1、方法与方法、属性与属性之间。 2、方法中变量声明与语句之间。 3、方法与方法之间。 4、方法中不同的逻辑块之间。 5、方法中的返回语句与其他的语句之间。 6、属性与方法、属性与字段、方法与字段之间。 7、注释与它注释的语句间不空行,但与其他的语句间空一行。
空格 在以下情况中要使用到空格 1、关键字和左括符 “(” 应该用空格隔开。如 while (true) 注意;在方法名和左括符 “(” 之间不要使用空格,这样有助于辨认代码中的方法调用与关键字。多个参数用逗号隔开,每个逗号后都应加一个空格。 2、除了 . 之外,所有的二元操作符都应用空格与它们的操作数隔开。一元操作符、++及--与操作 数间不需要空格。如 a+=c+d; a = (a + b) / (c * d); while(d++ = s++) { n++; } PrintSize(“size is “+size+“\n”); 3、语句中的表达式之间用空格隔开。如 for(expr1; expr2; expr3) 4、以下写法是不允许的: int j=i+k; 括号 - () 1、左括号“(”不要紧靠关键字,中间用一个空格隔开。 2、左括号“(”与方法名之间不要添加任何空格。 3、没有必要的话不要在返回语句中使用()。如 if (condition) (1) return 1 花括号 - {} 1、左花括号 “{”放于关键字或方法名的下一行并与之对齐。如 if (condition) { } public int Add(int x, int y) { } 2、 左花括号 “{”要与相应的右花括号 “}”对齐。 3、通常情况下左花括号 “{”单独成行,不与任何语句并列一行。 4、 if、while、do语句后一定要使用{},即使{}号中为空或只有一条语句。如 if(somevalue ==1) { somevalue = 2; } 右花括号“}”后建议加一个注释以便于方便的找到与之相应的 {。如 while(1) { if (valid) { } 11et已定义好的Xml标签来标记,在声明接口、类、方法、属性、字段都应该使用该类注释,以便代码完成后直接生成代码文档,让别人更好的了解代码的实现和接口。如 . . (the source code ) */ 单行注释 该类注释用于 1、方法内的代码注释。如变量的声明、代码或代码段的解释。注释示例: ET 开发环境中通过代码向导添加属性时,它将会为新属性添加 标记。然后,应该手动添加 标记以描述该属性所表示的值。
4申明 每行声明数 一行只建议作一个声明,并按字母顺序排列。如: int level; . } } 不过也有一个例外 for (int i = 0; i < maxLoops; i++) { ... } 应避免不同层次间的变量重名,如 int count; ... void MyMethod() { if (condition) { int count = 0; . } ... }
类和接口的声明 1 在方法名与其后的左括号间没有任何空格。 2 左花括号 “{”出现在声明的下行并与之对齐,单独成行。 3方法间用一个空行隔开。
字段的声明 不要使用是 public 或 protected 的实例字段。如果避免将字段直接公开给开发人员,可以更轻松地对类进行版本控制,原因是在维护二进制兼容性时字段不能被更改为属性。考虑为字段提供 get 和set 属性访问器,而不是使它们成为公共的。 get 和 set 属性访问器中可执行代码的存在使得可以进行后续改进,如在使用属性或者得到属性更改通知时根据需要创建对象。下面的代码示例阐释带有get 和 set 属性访问器的私有实例字段的正确使用。示例: public class Control: Component { private int handle; public int Handle { get { return handle; } } }
5 命名规范 命名概述 名称应该说明“什么”而不是“如何”。通过避免使用公开基础实现(它们会发生改变)的名称,可以保留简化复杂性的抽象层。例如,可以使用 GetNextStudent(),而不是 GetNextArrayElement()。 命名原则是: 选择正确名称时的困难可能表明需要进一步分析或定义项的目的。使名称足够长以便有一定的意义,并且足够短以避免冗长。唯一名称在编程上仅用于将各项区分开。表现力强的名称是为了帮助人们阅读;因此,提供人们可以理解的名称是有意义的。不过,请确保选择的名称符合适用语言的规则和标准。 以下几点是推荐的命名方法。 1、避免容易被主观解释的难懂的名称,如方法名AnalyzeThis(),或者属性名xxK8。这样的名称会导致多义性。 2、在类属性的名称中包含类名是多余的,如 。而是应该使用 。 3、只要合适,在变量名的末尾或开头加计算限定符(Avg、Sum、Min、Max、Index)。 4、在变量名中使用互补对,如 min/max、begin/end 和 open/close。 5、布尔变量名应该包含 Is,这意味着 Yes/No 或 True/False 值,如 fileIsFound。 6、在命名状态变量时,避免使用诸如 Flag 的术语。状态变量不同于布尔变量的地方是它可以具有两个以上的可能值。不是使用 documentFlag,而是使用更具描述性的名称,如 documentFormatType。 (此项只供参考) 7、即使对于可能仅出现在几个代码行中的生存期很短的变量,仍然使用有意义的名称。仅对于短循环索引使用单字母变量名,如 i 或 j。 可能的情况下,尽量不要使用原义数字或原义字符串,如 For i = 1 To 7。而是使用命名常数,如 For i = 1 To NUM_DAYS_IN_WEEK 以便于维护和理解。 大小写规则 大写 标识符中的所有字母都大写。仅对于由两个或者更少字母组成的标识符使用该约定。例如:
下表汇总了大写规则,并提供了不同类型的标识符的示例。 标识符 大小写 示例 类 Pascal AppDomain 枚举类型 Pascal ErrorLevel 枚举值 Pascal FatalError 事件 Pascal ValueChange 异常类 Pascal WebException 注意 总是以 Exception 后缀结尾。 只读的静态字段 Pascal RedValue 接口 Pascal IDisposable注意 总是以 I 前缀开始。 方法 Pascal ToString 命名空间 Pascal 属性 Pascal BackColor 公共实例字段 Pascal RedValue 注意 很少使用。属性优于使用公共实例字段。 受保护的实例字段 Camel redValue注意 很少使用。属性优于使用受保护的实例字段。 私有的实例字段 Camel redValue 参数 Camel typeName
方法内的变量 Camel backColor 缩写 为了避免混淆和保证跨语言交互操作,请遵循有关区缩写的使用的下列规则: 1 不要将缩写或缩略形式用作标识符名称的组成部分。例如,使用 GetWindow,而不要使用 GetWin。 2不要使用计算机领域中未被普遍接受的缩写。 3在适当的时候,使用众所周知的缩写替换冗长的词组名称。例如,用 UI 作为 User Interface 缩 写,用 OLAP 作为 On-line Analytical Processing 的缩写。