ITPub博客

首页 > Linux操作系统 > Linux操作系统 > 金蝶EAS BOS开发规范,也可作为java的开发规范(一)

金蝶EAS BOS开发规范,也可作为java的开发规范(一)

原创 Linux操作系统 作者:xxjnw 时间:2008-03-11 00:21:10 0 删除 编辑
 

1.  简介

1.1.  目的

本文档的目的是说明将在 开发 系统时使用的标准、约定和代码模式。

1.2.  范围

本文档适用于EAS开发过程。

1.3.  定义、首字母缩写词和缩略语

风格: 指对编程中有影响的命名、表达式和语名、排版、注释的要求。

函数规范: 对函数定义的要求,包括参数、内部实现、返回值的一些规范。

类型使用: 包括基类、值类型、委托、属性、嵌套类的使用指南。

异常处理: 程序错误的捕获与处理的统一机制。

性能: 描述硬件设备对性能造成的瓶颈与相应的对策。

质量保证: 程序正确性,稳定性、安全性,可测试性,规范/可读性,全局效率,局部效率,个人表达方式/个人方便性的一些

通用类: 多语言、通用数据库访问类等的公用组件。

1.4.  参考资料

1、《程序设计实践》 Brian W.Kernighan,RobPike著裘宗燕 译   机械工业出版社

1.5.  概述

任何的软件设计中,都离不开编程实现。在软件实现中,除了程序架构设计、数据结构设计、算法的设计以外,还有具体的代码的编写规范问题。

好的代码应该具有以下的特征:

准确性: 它能保证程序运行稳定、正确,不容易出错;

简单性 :它能使程序代码短而容易管理;

清晰性: 它保证程序容易理解,无论对人还是计算机;

普遍性: 它意味着程序在很广泛的情况下都能工作的很好,也容易做修改以适应新出现的情况;

自动化: 借助计算机帮助我们做一些工作,使人能摆脱许多琐碎的工作。

这些好的编程要素对应到实践中,我们就可以从以下几个方面来进行 规范约束

风格处理: 包含命名规范,表达示和语句的选择,缩进格式,注释要求等。

函数处理: 包含参数规则,内部实现规则,返回值规则,注意事项。

错误处理: 错误来源,错误提示,错误解决方案。

性能: 瓶颈与代码调整。

质量保证: 质量保证的一些注意事项。

可重用性: 公用组件,WebControl。

由于在EAS开发中,我们采用Java编程语言与JavaScript脚本语言,本文档中就主要对这两种语言进行规范。

2.  风格规范

2.1.  风格概述

好的程序书写规范比随意的书写规范更清晰、错误更少、更易修改。所以,一开始就要注意使用好的编写风格。

在实际的开发中,由于项目期限等原因,开发人员逐渐养成了一些不良的习惯。命名随意,注释不清晰,表达示与语句使用不规范、程序的缩进不一致。这些看似无关紧要的事情,其实对程序的质量影响非常之大。轻则别人看不懂你的程序,重则自己过后都无法下手去修改程序的错误,更不要提优化处理。

可以这么说,好的程序设计风格就如同好的文章,不仅要求语句顺畅,而且段落分明,结构紧凑。不仅排版要清晰,标点符号正确使用,而且重点要突出,中心明确。

让我们从这些基本的编程技术基础上入手,改正以前的不良习惯,逐步提高程序的质量。

2.2.  命名规范

参见

<< 2_G_开发指南_Java编码规范>>

<< 1_G_JavaScript编码规范>>

2.3.  表达示和语句 规范

表达示和语句是程序中使用最多的基本语法,也是构成程序逻辑的基本要素,它们的不合理使用很大地影响了程序的清晰性、简洁性。

使用括号

在表达示中,因为算术运算符,关系运算符和逻辑运算符的优先级别一般很难记清,这时最好采用 () 括号进行分解处理,使用表达示更清晰,排除二义性。

例如:

word = (high << 8) | low

注意一元运算符  +  -  *  的优先级高于对应的二元运算符。

运算符的优先级:

优先级

运算符

结合律

( )  [ ]

从左至右

 ~   ++  --    +  - 

从右至左

*  /  %

从左至右

+  -

从左至右

<< >> >>>

从左至右

<<=  >>=  instanceof

从左至右

==  !=

从左至右

&

从左至右

^

从左至右

|

从左至右

&&

从左至右

||

从左至右

?:

从左至右

=  +=  -=  *=  /=  %=  &=  |=  ^=  <<=  >>= 

>>>=

从右至左

表2 -1  运算符的优先级与结合律

来自 “ ITPUB博客 ” ,链接:http://blog.itpub.net/715744/viewspace-202019/,如需转载,请注明出处,否则将追究法律责任。

请登录后发表评论 登录
全部评论

注册时间:2008-02-15

  • 博文量
    14
  • 访问量
    55627