编码规范Word文档格式.docx
- 文档编号:16560629
- 上传时间:2022-11-24
- 格式:DOCX
- 页数:31
- 大小:407.48KB
编码规范Word文档格式.docx
《编码规范Word文档格式.docx》由会员分享,可在线阅读,更多相关《编码规范Word文档格式.docx(31页珍藏版)》请在冰豆网上搜索。
6、包的导入9
第五章命名规范10
1、命名概述10
2、大小写规则11
3、缩写11
4、包(package)12
5、类(class)12
6、接口(interface)13
7、枚举(enum)13
8、常量(const)14
9、变量(variate)14
10、字段(field)15
11、静态字段(staticfield)15
12、属性(sproperty)15
14、方法(method)16
15、参数(parameter)17
16、集合(collection)17
17、页面(page)17
18、关键字(keyword)18
第六章语句19
1、每行一个语句19
2、复合语句19
3、return语句19
4、if、if-else、if-elseif-else语句19
5、while、do-while语句20
6、for、foreach语句20
7、switch-case语句21
8、异常处理语句21
9、方法体22
第七章框架23
1、目录结构23
2、struts.xml23
第一章概述
1、规范制定原则
1.方便代码的交流和维护。
2.不影响编码的效率,不与大众习惯冲突。
3.使代码更美观、阅读更方便。
4.使代码的逻辑更清晰、更易于理解。
2、术语定义
2.1、Pascal大小写
将标识符的首字母和后面连接的每个单词的首字母都大写。
可以对三字符或更多字符的标识符使用Pascal大小写。
例:
BackColor
2.2、Camel大小写
标识符的首字母小写,而每个后面连接的单词的首字母都大写。
backColor
3、文件
3.1、文件命名
1.文件名遵从Pascal命名法,无特殊情况,扩展名小写。
例:
MyFirst.java
2.使用统一而又通用的文件扩展名。
Java类(.java)、XML文件(.xml)
3.2、文件注释
1.在每个文件头必须包含以下注释说明
/*
*Copyright(C)福州同创志恒网络科技有限公司版权所有。
*文件名:
*文件功能描述:
*创建标识:
*
*修改标识:
*修改描述:
*……
*/
2.文件功能描述只需简述,具体详情在类的注释中描述。
3.创建标识和修改标识由创建或修改人员的拼音或英文名加日期组成。
周翔20040408
4.一天内有多个修改的只需做一个在注释说明中做一个修改标识就够了。
5.在所有的代码修改处加上修改标识的注释。
3.3、文件长度
文件长度2000行以内
第二章代码外观
1、列宽
代码列宽控制在80字符左右。
即每行80字符
2、换行
当表达式超出或即将超出规定的列宽,遵循以下规则进行换行
1.在逗号后换行。
2.在操作符前换行。
3.规则1优先于规则2。
当以上规则会导致代码混乱的时候自己采取更灵活的换行规则。
3、空行
空行是为了将逻辑上相关联的代码分块,以便提高代码的可阅读性。
1.在以下情况下使用两个空行
1)接口和类的定义之间。
2)枚举和类的定义之间。
3)类与类的定义之间。
2.在以下情况下使用一个空行
1)方法与方法、属性与属性之间。
2)方法中变量声明与语句之间。
3)方法与方法之间。
4)方法中不同的逻辑块之间。
5)方法中的返回语句与其他的语句之间。
6)属性与方法、属性与字段、方法与字段之间。
7)注释与它注释的语句间不空行,但与其他的语句间空一行。
4、空格
在以下情况中要使用到空格
1.关键字和左括符“(”应该用空格隔开。
如:
while(true)
注意:
在方法名和左括符“(”之间不要使用空格,这样有助于辨认代码中的方法调用与关键字。
2.多个参数用逗号隔开,每个逗号后都应加一个空格。
3.除了“.”之外,所有的二元操作符都应用空格与它们的操作数隔开。
a+=c+d;
a=(a+b)/(c*d);
4.一元操作符、++及--与操作数间不需要空格。
while(d++=s++){
n++;
}
5.语句中的表达式之间用空格隔开。
for(expr1;
expr2;
expr3)
5、括号-()
1.左括号“(”不要紧靠关键字,中间用一个空格隔开。
if(condition)
2.左括号“(”与方法名之间不要添加任何空格。
Arrays.sort(nums)
3.没有必要的话不要在返回语句中使用()。
return1;
6、花括号-{}
1.左花括号“{”放于关键字或方法名的同行,并用一个空格间隔。
if(condition){
publicintAdd(intx,inty){
2.左花括号“{”要与相应的右花括号“}”同列对齐。
3.if、while、do语句后一定要使用{},即使{}号中为空或只有一条语句。
if(somevalue==1){
somevalue=2;
4.右花括号“}”后建议加一个注释以便于方便的找到与之相应的“{”。
while(condition1){
if(condition2){
}//ifcondition2
else{
}//notcondition2
}//endcondition1
第三章程序注释
1、注释概述
1.修改代码时,总是使代码周围的注释保持最新。
2.在每个例程的开始,提供标准的注释样本以指示例程的用途、假设和限制很有帮助。
注释样本应该是解释它为什么存在和可以做什么的简短介绍。
3.避免在代码行的末尾添加注释;
行尾注释使代码更难阅读。
不过在批注变量声明时,行尾注释是合适的;
在这种情况下,将所有行尾注释在公共制表位处对齐。
//打印方法
print(“”);
intnum;
//设置变量
4.避免杂乱的注释,如一整行星号。
而是应该使用空白将注释同代码分开。
5.避免在块注释的周围加上印刷框。
这样看起来可能很漂亮,但是难于维护。
6.在部署发布之前,移除所有临时或无关的注释,避免在日后的维护工作中产生混乱。
7.如果需要用注释来解释复杂的代码节,请检查此代码以确定是否应该重写它。
尽一切可能不注释难以理解的代码,而应该重写它。
尽管一般不应该为了使代码更简单以便于人们使用而牺牲性能,但必须保持性能和可维护性之间的平衡。
8.在编写注释时使用完整的句子。
注释应该阐明代码,而不应该增加多义性。
9.在编写代码时就注释,因为以后很可能没有时间这样做。
另外,如果有机会复查已编写的代码,在今天看来很明显的东西六周以后或许就不明显了。
10.避免多余的或不适当的注释,如幽默的不主要的备注。
11.使用注释来解释代码的意图。
它们不应作为代码的联机翻译。
12.注释代码中不十分明显的任何内容。
13.为了防止问题反复出现,对错误修复和解决方法代码总是使用注释,尤其是在团队环境中。
14.对由循环和逻辑分支组成的代码使用注释。
这些是帮助源代码读者的主要方面。
15.在整个应用程序中,使用具有一致的标点和结构的统一样式来构造注释。
16.用空白将注释同注释分隔符分开。
在没有颜色提示的情况下查看注释时,这样做会使注释很明显且容易被找到。
17.所有的代码修改处加上修改标识的注释。
2、文档型注释
该类注释采用JavaDoc来标记,在声明接口、类、方法、属性、字段都应该使用该类注释,以便代码完成后直接生成代码文档,让别人更好的了解代码的实现和接口。
/**
*功能描述:
*创建标识:
*
*修改标识:
*修改描述:
*……
*@param参数名称参数类型参数说明
*@return返回值类型
返回值说明
*@throws异常类型
*/
publicstaticvoidmain(Stringargs[])throwsException{
}
3、块级别注释
1.包围代码块
/*------start:
订单处理------*/
//Dosomethinghere
/*--------end:
订单处理-------*/
2.可以考虑使用大括号来表示注释范围
/*----------订单处理-------*/
{
//Dosomethinghere
4、单行注释
该类注释用于:
1.方法内的代码注释。
如变量的声明、代码或代码段的解释。
//注释语句
privateintnumber;
2.方法内变量的声明或花括号后的注释。
if(1==1){//alwaystrue
//Dosomethinghere
}//alwaystrue
3.如果做过修改需加上修改者和日期
Stringusername;
//修改者修改日期说明
5、备注
建议注释:
1.循环语句和判断语句前必须注释。
2.特殊变量声明时需要注释。
3.如果方法允许Null作为参数,或者允许返回值为Null,必须在JavaDoc中说明。
4.注释中的第一个句子要以(英文)句号、问号或者感叹号结束。
Javadoc生成工具会将注释中的第一个句子放在方法汇总表和索引中。
5.注释不是用来管理代码版本的,如果有代码不要了,直接删除,svn会有记录的,不要注释掉,否则以后没人知道那段注释掉的代码该不该删除。
第四章声明
1、每行声明数
一行只建议作一个声明,并按字母顺序排列。
intlevel;
//推荐
intsize;
intx,y;
//不推荐
2、初始化
建议在变量声明时就对其做初始化。
3、位置
变量建议置于块的开始处,不要总是在第一次使用它们的地方做声明。
voidMyMethod(){
intint1=0;
//在方法块开始
if(condition){
intint2=0;
//在if语句块开始
//Dosomethinghere
}
不过也有一个例外
for(inti=0;
i<
maxLoops;
i++){
应避免不同层次间的变量重名,
intcount;
//已声明
intcount=0;
//重复声明,会覆盖,应避免
4、类和接口的声明
1.在方法名与其后的左括号间没有任何空格。
2.左花括号“{”出现在声明的同行,并用一个空格间隔。
3.方法间用一个空行隔开。
5、字段的声明
不要使用是public或protected的实例字段。
如果避免将字段直接公开给开发人员,可以更轻松地对类进行版本控制,原因是在维护二进制兼容性时字段不能被更改为属性。
考虑为字段提供get和set属性访问器,而不是使它们成为公共的。
get和set属性访问器中可执行代码的存在使得可以进行后续改进,如在使用属性或者得到属性更改通知时根据需要创建对象。
publicclassControl{
privateinthandle;
publicintgetHandle(){
returnthis.handle;
}
publicvoidsetHandle(inthandle){
this.handle=handle;
6、包的导入
删除不用的导入,尽量不要使用整个包的导入。
经常使用快捷键ctrl+shift+o修正导入。
第五章命名规范
1、命名概述
名称应该说明“什么”而不是“如何”。
通过避免使用公开基础实现(它们会发生改变)的名称,可以保留简化复杂性的抽象层。
例如,可以使用getNextStudent(),而不是getNextArrayElement()。
命名原则采用英语单词为主,遇到无法用英语单词的地方,可以采用拼音全拼方式,具体规则如下:
1.选择正确名称时的困难可能表明需要进一步分析或定义项的目的。
2.使名称足够长以便有一定的意义,并且足够短以避免冗长。
3.唯一名称在编程上仅用于将各项区分开。
4.表现力强的名称是为了帮助人们阅读;
因此,提供人们可以理解的名称是有意义的。
5.请确保选择的名称符合适用语言的规则和标准。
以下几点是推荐的命名方法。
1.避免容易被主观解释的难懂的名称,如方法名analyzeThis(),或者字段名xxK8。
这样的名称会导致多义性。
2.在类字段的名称中包含类名是多余的,如Book.bookTitle。
而是应该使用Book.title。
3.只要合适,在变量名的末尾或开头加计算限定符(Avg、Sum、Min、Max、Index)。
4.在变量名中使用互补对,如min/max、begin/end和open/close。
5.布尔变量名应该包含is,这意味着Yes/No或True/False值,如fileIsFound。
6.在命名状态变量时,避免使用诸如Flag的术语。
状态变量不同于布尔变量的地方是它可以具有两个以上的可能值。
不是使用documentFlag,而是使用更具描述性的名称,如documentFormatType。
(此项只供参考)
7.即使对于可能仅出现在几个代码行中的生存期很短的变量,仍然使用有意义的名称。
仅对于短循环索引使用单字母变量名,如i或j。
可能的情况下,尽量不要使用原义数字或原义字符串,
for(inti=0;
7;
应该使用命名常数,以便于维护
NUM_DAYS_IN_WEEK;
2、大小写规则
下表汇总了大小写规则,并提供了不同类型的标识符的示例。
标识符
大小写
示例
类
Pascal
AppDomain
枚举类型
ErrorLevel
枚举值
FatalError
异常类
WebException
总是以Exception后缀结尾。
接口
IDisposable
总是以I前缀开始。
常量
RED_VALUE
全部大写,多个单词间用下划线分割
包
org.tcedu.entity
用域名的颠倒作为开头,且全部小写
公共实例字段
Camel
redValue
受保护的实例字段
私有的实例字段
redValue
属性
方法
toString()
参数
typeName
方法内的变量
3、缩写
为了避免混淆和保证跨语言交互操作,请遵循有关区缩写的使用的下列规则:
1.不要将缩写或缩略形式用作标识符名称的组成部分。
例如,使用GetWindow,而不要使用GetWin。
2.不要使用计算机领域中未被普遍接受的缩写。
3.在适当的时候,使用众所周知的缩写替换冗长的词组名称。
用UI作为UserInterface缩写,用OLAP作为On-lineAnalyticalProcessing的缩写。
4.使用缩写时,对于超过两个字符长度的缩写请使用Pascal大小写或Camel大小写。
使用HtmlButton或HTMLButton。
但是,应当大写仅有两个字符的缩写,
UI,而不是Ui。
5.不要在标识符或参数名称中使用缩写。
如果必须使用缩写,对于由多于两个字符所组成的缩写请使用Camel大小写,虽然这和单词的标准缩写相冲突。
4、包(package)
1.命名包时的一般性规则是业务领域名.子系统名.层名
org.tcedu.dao.weibo
2.包名全部小写,用“.”分隔开。
3.technology指的是该项目的英文缩写,或软件名。
4.包和类不能使用同样的名字。
5、类(class)
1.用名词或名词短语命名类。
使用Pascal大小写。
2.使用全称避免缩写,除非缩写已是一种公认的约定,如URL、HTML
3.不要使用类型前缀,如在类名称上对类使用C前缀。
使用类名称FileStream,而不是CFileStream。
4.不要使用下划线字符“_”。
5.有时候需要提供以字母I开始的类名称,虽然该类不是接口。
只要I是作为类名称组成部分的整个单词的第一个字母,这便是适当的。
例如,类名称IdentityStore是适当的。
6.在适当的地方,使用复合单词命名派生的类。
派生类名称的第二个部分应当是基类的名称。
ApplicationException对于从名为Exception的类派生的类是适当的名称,原因ApplicationException是一种Exception。
7.匿名内部类20行以内,太长的匿名内部类影响代码可读性,建议重构为命名的(普通)内部类。
8.类名往往用不同的后缀表达额外的意思
后缀名
意义
举例
Service
表明这个类是个服务类,里面包含了给其他类提同业务服务的方法
PaymentOrderService
Impl
这个类是一个实现类,而不是接口
PaymentOrderServiceImpl
Dao
这个类封装了数据访问方法
PaymentOrderDao
Action
直接处理页面请求,管理页面逻辑了类
UpdateOrderListAction
Listener
响应某种事件的类
PaymentSuccessListener
Event
这个类代表了某种事件
PaymentSuccessEvent
Servlet
一个Servlet
PaymentCallbackServlet
Factory
生成某种对象工厂的类
PaymentOrderFactory
Adapter
用来连接某种以前不被支持的对象的类
DatabaseLogAdapter
Job
某种按时间运行的任务
PaymentOrderCancelJob
Wrapper
这是一个包装类,为了给某个类提供没有的能力
SelectableOrderListWrapper
Bean
这是一个POJO
MenuStateBean
6、接口(interface)
以下规则概述接口的命名指南:
1.用名词或名词短语,或者描述行为的形容词命名接口。
Ø
接口名称IComponent使用描述性名词。
接口名称ICustomAttributeProvider使用名词短语。
接口名称IPersistable使用形容词。
2.少用缩写。
3.给接口名称加上字母I前缀,以指示该类型为接口。
在定义类/接口对(其中类是接口的标准实现)时使用相似的名称。
两个名称的区别应该只是接口名称上有字母I前缀。
5.当类是接口的标准执行时,定义这一对类/接口组合就要使用相似的名称。
两个名称的不同之处只是接口名前有一个I前缀。
例:
publicinterfaceIServiceProvider
publicinterfaceIFormatable
7、枚举(enum)
以下规则概述枚举的命名指南:
1.对于enum类型,使用Pascal大小写。
3.不要在enum类型名称上使用Enum后缀。
4.对大多数Enum类型使用单数名称,但是对作为位域的enum类型使用复数名称。
5.全大写,用下划线分割
publicenumEvents{
ORDER_PAID,
ORDER_CREATED
8、常量(const)
以下规则概述常量的命名指南:
所有单词大写,多个单词之间用“_”隔开。
publicstaticfinalstringPAGE_TITLE="
Welcome"
;
9、变量(variate)
以下规则概述变量的命名指南
1.使用Camel大小写。
2.定义局部变量尽量在那段代码的开始处,如方法的开始处。
publicvoidshow(){
Stringusername;
3.如果是if,for,while代码块,尽量在左花括号“{”的下一行处定义要使用的局部变量。
Stringusername;
//Dosomethinghere
序号
变量
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 编码 规范