软件设计规范(编程)

《软件设计规范(编程)》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、软件设计规范1命名规则1.1包的命名规则包是一组相关类和接口的集合，它将类和接口有机地组织成层次结构，使类和接口具有清晰的名称空间。包的命名规则如下：（1）包名应该有意义，能反映包中的内容。（2）包名应该是独有的、不可重复的。（3）包名可以采用倒序的公司域名，本系统的所有包都以“com”开头。1.2类和接口的命名规则类和接口是Java的核心成员，必须要有一个中心目的，其命名规则如下。（1）类与接口的名字应该表达其中心目的。（2）类与接口的名字一般是大写字母开头。（3）类与接口的名字可以由若干单词组成，单词的第一个字母采用大写字母，其余字母

2、采用小写字母。（4）一般不用动词来命名。1.3方法的命名规则方法用来描述对象所具有的功能或操作，反映对象的行为，其命名规则如下。（1）方法一般使用动词。（2）方法名的第一个字母应该是小写。（3）在多个单词混合的情况下，第一个单词后的所有单词的第一个字母大写，其余字母小写。1.4变量的命名规则变量包括成员变量、静态变量、类对象以及局部变量等。变量的命名规则如下：（1）变量名应该易于记忆、理解，紧凑而有意义。（2）变量名的第一个字母应该小写，避免使用

3、“_”或“$”作为第一个字母。（3）在多个单词混合的情况下，第一个单词后的所有但系的第一个字

4、母大写，其余小写。1.5常量的命名规则常量一般采用大写字母单词命名，单词之间用下划线连接。例如，以下的代码定义了表示最大的长度和最小常量的两个常量。staticfinalintMIX_LENGTH=1;staticfinalintMAX_LENGTH=100;2注释方法注释的目的在于说明程序，给自己或他人在阅读程序的时候提供帮助，增强程序的可读性。源程序文件注释，块注释，和行注释2.1源程序文件地注释源程序文件注释一般在文件开头说明文件地功能，目的以及开发的相关信息，主要包括文件名、功能、目的、版本、开发者、开发时间、最后修改时间、修改人

5、信息。下面是一个java类的文件的注释。/****************************************************************************文件名：ProductServlet.java功能：商品类的控制器，用来控制维护商品信息的流程。版本：2.0版权所有：天津电子信息职业技术学院开发者：宋国庆开放日期：2004—06-28修改者：王新强最后修改的日期：2007-05-21*********************************************************

6、*****************/2.2块注释块注释通常用于说明类、方法或程序段的意义及用途。块注释一般位于类、方法、或程序段的前面，应该与所描述的代码处于同一个缩进层次上。下面的块注释用来说明方法query的作用。/***查询所有的满足条件的员工信息*参数model：检索条件*返回：符合条件的员工集合*/publicCollectionquery(Objectmodel)throwsDAOException{……}2.3行注释行注释可为单独行注释、行尾注释与行头注释3种方式。单独行注释是在单独的一行中书写注释信息，一般用来描述较短的注

7、释信息；行尾注释位于代码后面，与所要注释的代码行处于同一行；行头注释位于代码的前面，通常用来在程序调试中使少量代码失效。下面的例子中包含了这3中注释的使用方法。/*根据状态返回相应的结果*///这是单独的行注释if(static==GOOD)return100;//如果状态很好，则返回100//这是行尾注释//elsereturn60;//这是行头注释3源文件编排格式一个程序如果写的密密麻麻的，分不清层次，就会让人看不懂。好的程序应该充分的利用缩进、空白、续行等编排手段展现程序的可读性。下面介绍java源文件的编排格式3.1缩进规则缩进是

8、指照程序语句的隶属关系向右做阶梯式移动。缩进单位一般为4个空格键，相当于半个tab键。有时缩进单位也采用一个tab键，即8个空格键，这种缩进称为深度缩进。缩进要注意逻辑层次，同一层次的语句必须在相同的缩进位置上。以下程序在双重循环中使用了缩进格式。ints=0;for(inti=0;i<3;i++){intt=0;for(intj=0;j<8;j++){t=t+j;s=s+t;}}3.2空格的应用原则空格的合理应用可以增强程序源代码的清晰性和可读性，其应用规则如下。（1）关键字与括号之间要加空格。（2）参数列表中的逗号后面要插入空格。（3

9、）表达式的双目运算符与操作数之间应该添加空格。（4）For语句中的表达式之间应该用空格分开。例子以下的程序没有应用空格的规则，可读性差。、PublicintdemoSpace(intdata[