软件编程规范JAVAWord下载.docx
《软件编程规范JAVAWord下载.docx》由会员分享，可在线阅读，更多相关《软件编程规范JAVAWord下载.docx（20页珍藏版）》请在冰点文库上搜索。
importjava.io.*;
/**
*<
p>
文件名称:
题目名称<
/p>
文件描述:
本类描述<
版权所有:
版权所有（C）2001-2004<
公司:
大连理工大学自动化研究所<
内容摘要:
//简要描述本文件的内容，包括主要模块、函数及其功能的说明<
其他说明:
//其它内容的说明<
完成日期：
//输入完成日期<
*@version1.0
*@author作者姓名
修改记录1:
//修改历史记录，包括修改日期、修改者及修改内容<
pre>
*修改日期：
*版本号：
*修改人：
*修改内容：
/pre>
修改记录2：
…<
*/
publicclassClassName
{
}
【规则2-1-2】程序中一行的代码和注释不能超过120列。
包括空格在内不超过120列。
【规则2-1-3】if、else、elseif、for、while、do等语句独占一行，执行语句不得紧跟其后。
不论执行语句有多少都要加{}。
这样可以防止书写失误，也易于阅读。
正例：
if（varible1<
varible2）
varible1=varible2;
或
varible2）{
反例：
下面的代码执行语句紧跟if的条件之后，而且没有加{}，违反规则。
varible2）varible1=varible2;
4.2空行空格
【规则2-3-1】不同逻辑程序块之间要使用空行分隔。
空行起着分隔程序段落的作用。
适当的空行可以使程序的布局更加清晰。
voiddoSomething（）
//[doSomething实现代码]
//空一行
voiddoOtherThing（）
[doOtherThing实现代码]
[doSomething实现代码]
//两个函数的实现是两个逻辑程序块，应该用空行加以分隔。
5注释
注释有助于理解代码，有效的注释是指在代码的功能、意图层次上进行注释，提供有用、额外的信息，而不是代码表面意义的简单重复。
Java注释的方式有：
行注释：
“//注释内容”和“/**注释内容*/”两种注释形式。
文档型注释：
“/**注释内容*/”分成多行书写的形式，注释内容里包含标签。
一般类公共变量的声明采用行注释。
类、接口、构造函数、方法等的声明采用文档型注释
【规则3-1】注释使用中文注释。
与doc有关的标准英文单词标签保留。
文档型注释描述了Java类（Javaclasses），接口（interfaces），构造函数（constructors）、方法（methods）和域（fields）。
每一个文档注释都包含在/**…*/分隔符中，每一个类（class）、接口（interface）或成员（member）都有一个注释。
这些注释应该只出现在声明（declaration）前。
标签
用处
用途
@author作者的名称
类、接口
说明特定某一段程序代码的作者。
每一个作者各有一个标记。
@deprecated
类、方法
说明该类的应用程序编程接口（API）已被废弃，因此应不再使用。
@exceptionnamedescription
方法
说明由方法发出的异常。
一个异常采用一个标记，并要给出异常的完整类名。
@paramname参数名的描述
用来说明传递给一个方法的参数，其中包括参数的类型/类和用法。
每个参数各有一个标记。
@return方法返回值的描述
若方法有返回值，对该返回值进行说明。
应说明返回值的类型/类和可能的用途。
@since
例如：
sinceJDK1.1：
说明自从有JDK1.1以来，该项已存在了多长时间。
@see类名
类、接口、方法、字段
在文档中生成指向特定类的超文本链接。
可以并且应该采用完全合法的类名。
@seeClassName#memberfunctionName
在文档中生成指向特定方法的超文本链接。
@version版本号
说明特定一段代码的版本信息。
【规则3-2】文件头部必须进行注释。
注释必须列出：
版权信息、文件标识、内容摘要、版本号、作者、完成日期、修改信息等。
下面是文件头部的中文注释：
//简要描述本文件的内容，包括主要模块、函数及能的说明<
//输入完成日期，例：
2008年2月25日<
【规则3-3】公共方法前面应进行文档型注释，列出：
函数的目的/功能、输入参数、返回值等。
功能描述、输入参数、返回值等，对于成员属性的get/set操作可以不加注释。
下面是公共方法头部的注释：
/**
*方法描述。
*@paramid编号
*@return名称
*/
publicStringgetName（Stringname）
returnname;
}
【规则3-4】保证代码和注释的一致性。
修改代码的同时修改相应的注释，不再有用的注释要删除。
【规则3-5】注释应与其描述的代码相近，对代码的注释应放在其上方（需与其上面的代码用空行隔开）或右方（对单条语句的注释）相邻位置，不可放在下面。
如下书写结构比较清晰
//获得子系统索引
subSysIndex=data.getSysIndex;
//代码段1注释
[代码段1]
/*代码段2注释*/
[代码段2]
反例1：
如下例子注释与描述的代码相隔太远。
/*获得子系统索引*/
subSysIndex=subSys.getSysIndex（）;
反例2：
如下例子注释不应放在所描述的代码下面。
〖建议3-1〗通过对方法、变量等正确的命名以及合理地组织代码结构，使代码成为自注释的。
清晰准确的方法、变量的命名，可增加代码的可读性，减少不必要的注释。
〖建议3-2〗尽量避免在注释中使用缩写，特别是不常用缩写。
在使用缩写时，应对缩写进行必要的说明。
6命名规则
好的命名规则能极大地增加可读性和可维护性。
同时，对于一个有上百个人共同完成的大项目来说，统一命名约定也是一项必不可少的内容。
本章对程序中的所有标识符（包括包、变量名、常量名、方法名、类名等）的命名做出约定。
对同一个项目内应使用统一的词汇表。
【规则4-1】标识符要采用英文单词或其组合，便于记忆和阅读，切忌使用汉语拼音来命名。
标识符应当直观且可以拼读，可望文知义，避免使人产生误解。
程序中的英文单词一般不要太复杂，用词应当准确。
【规则4-2】标识符只能由26个英文字母，10个数字及下划线的一个子集来组成，并严格禁止使用连续的下划线。
用户定义的标识符下划线不能出现在标识符的头尾。
这样做的目的是为了使程序易读。
因为variable_name和variable__name很难区分，下划线符号‘_’若出现在标识符头或结尾，容易与不带下划线‘_’的标识符混淆。
【规则4-3】标识符应当使用完整的英文描述，标识符的命名应当符合“min-length&
&
max-information”原则，谨慎使用缩写。
对于标识符应当使用完整的英文进行描述，对于整个描述较长的，可对单词进行缩略。
较短的单词可通过去掉“元音”形成缩写，较长的单词可取单词的头几个字母形成缩写，一些单词有大家公认的缩写，常用单词的缩写必须统一。
协议中的单词的缩写与协议保持一致。
对于某个系统使用的专用缩写应该在某处做统一说明。
设计命名中应该慎用缩写命名。
如要采用，则应采用统一的缩略规则，并且在代码的相应部分统一采用缩写。
例如，采用num作为number的缩写，那么在整个代码中应该始终使用该缩写。
如下单词的缩写能够被大家认可：
temp可缩写为tmp；
flag可缩写为flg；
statistic可缩写为stat；
increment可缩写为inc；
message可缩写为msg；
以下是一些常用缩写：
常用词
缩写
argument
arg
buffer
buf
clear
clr
clock
clk
compare
cmp
configuration
cfg
context
ctx
delay
dly
device
dev
disable
dis
display
disp
enable
en
error
err
function
fnct
hexadecimal
hex
initialize
init
mailbox
mbox
manager
mgr
maximum
max
message
msg
minimum
min
multiplex
mux
operatingsystem
OS
parameter
param
previous
prev
priority
prio
read
rd
ready
rdy
register
reg
schedule
sched
semaphore
sem
stack
stk
synchronize
sync
timer
tmr
trigger
trig
write
wr
【规则4-4】遵循统一的规范来书写包的声明，必须以com.ati开头。
对于包的声明，要遵循统一的命名规范来对包的声明进行说明。
大多数Java源文件的第一个非注释行是一个package语句。
包名总是小写，并且前缀是一个顶级域名（如当前的com,edu,gov,mil,net,org）或服从ISOAtandsrd3166,1981中规定的两英文字母国家标识符。
包名称的随后部分根据组织自身的命名规范变化。
这样的规范可通过指定分公司、部门、项目、机器、帐户等来确定。
packagecom.ati;
【规则4-5】类名采用大小写结合的方法，构成类名的每个单词的首字母的首字母也必须大写。
在构成类名的单词之间不用下划线。
【规则4-6】采用应用领域相关的术语来命名。
软件开发人员应注意软件用户的一些约定术语，不应当随意的创造术语，这会降低软件的易用性。
【规则4-7】程序中不要出现仅靠大小写区分的相似的标识符。
命名时应避免采用几乎相同的名称。
例如，变量名称persistentObject和persistentObjects不应当同时运用；
anSqlDatabase和anSQLDatabase也不应同时使用。
【规则4-8】用正确的反义词组命名具有互斥意义的变量或相反动作的函数等。
下面是一些在软件中常用的反义词组。
add/remove；
begin/end；
create/destroy；
insert/delete；
first/last；
get/set；
increment/decrement；
put/get；
add/delete；
lock/unlock；
open/close；
min/max；
old/new；
start/stop；
next/previous；
source/target；
show/hide；
send/receive；
source/destination；
cut/paste；
up/down
【规则4-9】常量名都要使用大写字母,用下划线‘_’分割单词。
staticfinalintMIN_WIDTH=4;
staticfinalintMAX_WIDTH=999;
staticfinalintGET_THE_CPU=1;
【规则4-10】一般变量名不得取单个字符（如i、j、k等）作为变量名，局部循环变量除外。
变量，尤其是局部变量，如果用单个字符表示，很容易出错（如l误写成1）,而编译时又检查不出，则有可能增加排错时间。
变量的命名应当选择精炼、意义明确的名字，才能简化程序语句，改善对程序功能的理解。
【规则4-11】变量名应该简短但意义完整，变量名的选择应该有助于记忆。
floatmyWidth;
byte[]buffer;
【规则4-12】控件命名应采用完整的英文描述符命名，名字的前缀是控件类型名。
这样容易区分一个控件的目的和它的类型，容易在一个表里找到各个控件。
btnOk
listCustomer
newFiles
【规则4-13】方法名应当能体现方法的作用，必须用小写字母开头的单词组合而成，且应当使用“动词”或者“动词＋名词”（动宾词组）。
方法名力求清晰、明了，通过方法名就能够判断方法的主要功能。
多个单词组合而成的方法名中，第一个单词后面的单词采用大小写字母结合的形式（首字母大写），但专有名词不受限制。
单词间不用下划线连接。
【规则4-14】获取性方法的命名有两类，一种是判断性的操作（获取属性的状态，返回值为boolean），如判断某些控件的状态等，对于这些操作，应当是以is为方法声明的开头。
另外一种是获取返回值的操作，对一这种操作，应当以get开头。
getFirstName（）
getAccountNumber（）
isPersistent（）
isAtEnd（）
【规则4-15】属性设置性的方法命名以set开头，后紧跟属性名。
根据这个标准来命名一个类的方法，可以很容易的让人明白这个方法的基本功能。
setFirstName（StringaName）
setAccountNumber（intanAccountNumber）
setReasonableGoals（VectornewGoals）
setPersistent（booleanisPersistent）
setAtEnd（booleanisAtEnd）
【规则4-16】To型方法：
表示类型转换的方法一般用to开头。
这些方法主要用来进行类型转换。
toString（）
7声明
【规则5-1】一行只声明一个变量。
intlevel;
intsize;
intlevel,size;
〖建议5-1〗变量声明应该只放在代码段的开始部分。
最好不要到使用时才声明变量。
voidmyMethod（）
{
intmyInt=0;
//方法块的开始
//其它语句
8表达式与语句
表达式是语句的一部分，它们是不可分割的。
表达式和语句虽然看起来比较简单，但使用时隐患比较多。
本章归纳了正确使用表达式和if、for、while、switch等基本语句的一些规则与建议。
【规则6-1】每一行应该只包括一个语句。
复杂的语句阅读起来难于理解，并容易隐含错误。
argv++;
argc--;
if（s4==null）s4=newString（“Joy”）;
【规则6-2】在表达式中使用括号，使表达式的运算顺序更清晰。
由于将运算符的优先级与结合律熟记是比较困难的，为了防止产生歧义并提高可读性，即使不加括号时运算顺序不会改变，也应当用括号确定表达式的操作顺序。
if（（（iYear%4==0）&
（iYear%100!
=0））||（iYear%400==0））
if（iYear%4==0&
iYear%100!
=0||iYear%400==0）
【规则6-3】当复合语句作为控制流程的一部分时，应该用‘{}’把所有的复合语句括起来，即使只有一句简单语句。
这样可以更方便地加入语句而不会由于忘掉加括号而引起的偶然性的错误。
intcount;
...
myMethod（）
if（condition）
count=1;
〖建议6-1〗循环嵌套次数不大于3次。
9类和接口
【规则7-1】类内部的代码布局顺序：
属性、构造函数、方法。
classTest
publicStringname;
publicTest（）
…;
publicvoidsetName（Stringname）
…;
privatevoidmethod（）
…
〖建议7-1〗功能相关的方法放在一起。
如接口中关系较紧密的的几个方法，类属性的get和set方法，有调用关系的方法，重载的方法等有相近或相关的方法尽可能放在一起，方便阅读。
classSampleextendsObject
intivar1;
intivar2;
Stringname;
Sample（inti,intj）
ivar1=i;
ivar2=j;
this.name=name;
publicStringgetName（）
returnthis.name;
intmethod1（）
…
method2（）;
voidmethod2（）
〖建议7-2〗函数的参数个数不宜超过4个。
过多的函数参数会导致性能降低。
〖建议7-3〗保证内部类定义成private，提高类的封装性。
升级会员 