CSDN博客

img luckychr

编码规范简要说明

发表于2002/5/9 13:17:00  644人阅读

一.在编码规范方面我推荐在Hungarian Notation(匈牙利记法):这种方法不仅符合国际编码标准,而且它确实使程序员减轻了代码的维护工作,提高了工作效率,在Hungarian Notation(匈牙利记法)中,变量具有一个描述性名称,如CountClassName,名字用大写字母开始。如果变量是一多词名则每个单词首字母需大写,然后,在描述性名称前,加上表示变量类型的字母(类型缩写),这样的好处就是程序员一看就知道变量的类型,而且也不容易忘记。其形式如下:

全局变量命= 范围前缀 + 下划线(_) + 类型前缀 + 数组前缀 + 自定义命名

局部变量命= 类型前缀 + 数组前缀 + 自定义命名

函数    = 类型前缀 + 自定义命名

控件命名    = 控件前缀 + 自定义命名

控件事件命名= 控件名称 +下划线(_) + 事件名称

程序文件命名= 模块名缩写 + 自定义命名

另外在源码中,要使层次分明,采用缩进(一般为4到5个空字符)的格式保持程序循环的层次结构和可读性。

其次,我建议类型缩写采用小写字母表示,原则是尽量简单明了,另外型缩写尽避免与计算机其它专业述语相似或相同,以免程序员发生错误理解。例如:

 

数据类型

前缀(类型缩写)

例子

Boolean

blnb

bTransactionData

Int

inti

iLoopFlag

Date

dt

dtCreateDate

 

控件类型

前缀(类型缩写)

例子

Combo

cmbcb

cmbLookup

Text

txt

txtTotalAmount

Radio

rd

rdTypeStatus

Select

slt

sltBankNo

 

二.在数据库表名及字段名命名设计中我认为也应该有个标准或规范:

数据库表命名 = 模块名缩写 + 自定义命名

字段命名     = 类型前缀 + 自定义命名

注意: 我不推荐在数据库表命名或字段命名中有下划线(_)或其特殊字符出现,因为这样很容易引起程序员的代码错误。

三.Java类中变量、函数的定义

  类的成员变量命名 = m + 下划线(_) + 类型前缀 + 数组前缀 + 自定义命名

  类的成员函数 = 类型前缀 + 自定义命名

  类的事件命     = 类名 + 下划线(_) +自定义命名

其它变量应按变量命名原则进行命名

 

注意类型前缀采用数据类型的缩写,并以小写字母表示;

自定义命名, 采用大小写结合的英文缩写,要求尽量能顾名思义.

四.程序的结构(以实际情况选择性包含)

公用的界面风格文件    (*.css)

公用的JavaScript文件 (*.js)

公用的JAVA类(Applet、Serverlet、Java Bean)

公用的查询框(*.lcf、Scriptlet)

程序员自已的源码

其它的公用函数

五.软件的界面

我认为在同一软件产品中发,统一的界面风格更能体显团队合作精神,公司的形象,并且还能突出产品的优势和改变用户看法,并且确确实实地让用户操作起来感觉更加方便、简单、易于熟练。另外我建议在我们今后的软件产品中都要支持键盘(给习惯用键盘用户的一次机会吗)、鼠标操作。对于界面的设计、颜色搭配我推荐参考Window,刷新界面尽可能做到最少。下面是我的一些看法:

1.界面的状态:我认为在数据库软件产品中界面状态大略可分为:新增、修改、查询、浏览四种状态,并且这几种状态一定要有所不同,这样才能体现软件功能的层次分明。给用户的感觉就是更加有条理性。

2. 界面的大小:我不推荐一个软件界面利用拖动滚动条来查看整个界面,我认为这样的结果可能导至用户操作不便,我们的工作效率降低,软件的操作速度降低等。我建议在将来的产品中,我们把界面进行分类,确定不同类型界面的宽度,对界面的高度应依实际情况而定(原则是:尽量避免出现垂直滚动条,做到美观,得体,多为用户着想)

3.界面文字、控件的大小、颜色、宽度等,我建议有一套统一的风格(定义在*.css中,我不推荐写程序源码中,至少应尽量避)

4.界面的内容,我推荐的是:界面描述性文字、控件采取左对齐原则,控件内显示的内容,字符采取左对齐、数字采取右对齐(应保留小数位)原则。对数据输入的有效性,应加以统一风格的控制。

六.公用函数

在软件工程中公用函数不仅能大大提高开发效率,而且也加快了程序运行速度,使程序易于维护。而且有些公用函数适用多个软件产品。试想这样会有什么好处呢?其实我觉得公用函数在软件产品中应处于首要地位。下面是我对公用函数的分类:

公用函数

用户权限

公用的查寻框

公用的静态数据(业务或界面)

公用的控件

公用的类

……

七.软件文档

相信,大家都知道文档在软件工程中至关重要,它不仅是软件业务流程的重要(文字性)说明,而且也是程序员编写,维护程序代码的有效依据,是测试人员的凭证,是用户使用的向导。我认为概要设计、需求分析、详细设计、维护指南、帮助(给用户的) 在软件工程中较为重要。并且我建议程序员书写这些文档(书写风格要保持一至)

 

0 0

相关博文

我的热门文章

img
取 消
img