项目开发规范

 

程序结构清析，简单易懂，单个函数的程序行数最好不超过200行。

打算干什么，要简单，直接了当，代码精简，避免垃圾程序。

尽量使用标准库函数和公共函数。

不要随意定义全局变量，尽量使用局部变量。

使用括号以避免二义性。

 

可读性要求要放在程序设计较高的层次考虑。

保持注释与代码完全一致。

每个源程序文件，都有文件头说明。

每个函数，都有函数头说明。

在典型算法前都有注释。

利用缩进来显示程序的逻辑结构，缩进量一致。

循环、分支层次不要超过五层。

空行和空白字符也是一种特殊注释。

一目了然的语句不加注释。

 

避免出现两条等价的支路。

用 CASE 实现多路分支。

避免从循环引出多个出口。

函数只有一个出口。

避免不必要的分支。

 

程序首先是正确，其次是优美。

无法证明你的程序没有错误，因此在编写完一段程序后，应先回头检查。

改一个错误时可能产生新的错误，因此在修改前首先考虑对其它程序的影响。

所有变量在调用前必须被初始化。

对所有的用户输入，必须进行合法性检查。

单元测试也是编程的一部份，提交联调测试的程序必须通过单元测试。

 

 

命名规则主要采用匈牙利命名法。

用小写字母的前缀表示变量的类型，前缀的下一个字母用大写。

前缀	类型	例子
str	String	String strUserName = “hanlinping”
i	int	iUserNumber = 0;
f	float	float  fSum = 0.0f;
d	double	double dPrice = 0.00;
b	Boolean	Boolean bIsParent = true;
c	char	char  cText = c;
str	String[]	String[]   strFieldS=[1,2,2]

 

第一个字母必须使用大写字母,要求用大小写字母组合规范类的命名

    public classLineChartApplet extends java.applet.Applet

{

                                                        

}

 

第一个字母必须使用小写字母,要求用大小写字母组合规范函数命名。

public String  removeDot(StringstrStr)

{

         

}

 

注释要求符合javadoc规范，以生成java类的api文档。

       方法的注释例子如下：

/**

* 图表报表程序自动生成-模板选取

* @param strReportType 报表类型  

* @param strTableName 表的名称

* @param strTempletType 报表模板类型

* @param strTableDesc 表名描述

* @param strSQL 输入的SQL语句

* @param strReportTitle 报表标题

* @param strSampleLabels 图表字段，X轴标签

* @param strSampleValues 标本字段，多个以逗号分隔

* @param strSeriesCount 标本系列总数

* @param strSeriesLabels 标本系列描述，多个以逗号分隔

*@return bValue 返回的结果，如果成功返回true，如果失败返回false，boolean类型

* @exception 图表报表程序自动生成-模板选取处理错误

*/

变量的注释例子如下：

/**

* strDBName 数据库的名称

*/

String strDBName="";

类的注释例子如下：

/**

 * @描述：数据库主要操作方法

 * @version 1.4/2004-12-20

 * @author  韩林平

 */

页面开发规则

jsp页面包含尽量少的业务处理代码

jsp页面不应该包含方法

jsp页面主要用来收集用户提交的数据和向用户响应返回的数据

文件命名规范

文件名全部由小写字母组成。

    文件名主体由该文件主要功能的英文意义单词或单词缩写组成。

    文件名总长度不超过30

    数据提交的后继文件名由前一个jsp的主体文件名＋submig.jsp构成

数据显示的后继文件名由前一个jsp的主体文件名＋info.jsp构成

数据明细显示的后继文件名由前一个jsp的主体文件名＋list.jsp构成

数据查询的文件名由主体意思＋query.jsp构成

    jsp文件一般以子系统为单位放在不同的路径下：

   

例：

       通讯模块：app/message

       座席管理：app/user

      咨询模块：app/refer

       客户信息：app/consumer

……