编码规范与其代码

《编码规范与其代码》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、项目编号文密档编号级4内部同学公寓治理系统编码规范及其代码说明兰州理工高校评审日期：2021年1月15日目录1.导言41.1目的41.2范畴41.3缩写说明41.4术语定义51.5引用标准51.6参考资料52.编码格式规范52.1缩进排版52.2行长度52.3断行规章：62.4空行73.命名规范73.1包〔Packages〕73.2类〔Classes〕83.3接口〔Interfaces〕83.4方法〔Methods〕83.5变量〔Variables〕83.6实例变量〔InstanceVariables〕83.7常量〔Constants〕84．声明规范84.1每行声明变量的数量94.2初始

2、化94.3布局94.4包的声明94.5类和接口的声明105．语句规范105.1简洁语句105.2复合语句106.注释规范106.1注释的方法116.2开头注释126.3类和接口的注释127.代码范例122/168.目录规范133/161.导言1.1目的该文档的目的是描述同学公寓治理系统项目的编码规范和对代码的说明，其主要内容包括：编码规范命名规范注释规范语句规范声明规范目录设置代码说明本文档的预期的读者是：开发人员项目治理人员质量保证人员1.2范畴该文档定义了本项目的代码编写规范，以及部分代码描述和全部代码的说明；1.3缩写说明MVCＭｏｄｅｌ－Ｖｉｅｗ－Ｃｏｎｔｒｏｌ（模式－视图－把握

3、）的缩写，表示一个三层的结构体系；EJBＥｎｔｅｒｐｒｉｓｅＪａｖａＢｅａｎ（企业级ＪａｖａＢｅａｎ）的缩写；4/161.1术语定义ClassJava程序中的一个程序单位，可以生成很多的实例；Packages由很多的类组成的工作包；1.2引用标准[1]《企业文档格式标准》[2]《Java语言编写规范》1.3参考资料[1]《实战ｓｔｒｕｃｔ》〔美〕ＴｅｄＨｕｓｔｅｄ机械工业出版社[2]《软件重构》清华高校出版社2.编码格式规范2.1缩进排版4个空格作为缩进排版的一个单位；2.2行长度尽量防止一行的长度超过80个字符，用于文档中的例子应当使用更短的行长，长度一般不超过70个字符；5/162.

4、3断行规章：当一个表达式无法容纳在一行内时，可以依据如下一般规章断开：在一个逗号后面断开在一个操作符前面断开宁可选择较高级别〔higher-level〕的断开，而非较低级别〔lower-level〕的断开〔见下面的例子〕新的一行应当与上一行同一级别表达式的开头处对齐假如以上规章导致你的代码纷乱或者使你的代码都堆挤在右边，那就代之以缩进8个空格以下是两个断开算术表达式的例子；前者属于更高级别的断开，由于断开处位于括号表达式的外边；longName1=longName2*〔longName3+longName4-longName5〕+4*longname6;//举荐longName1=lon

5、gName2*〔longName3+longName4-longName5〕+4*longname6;//防止以下是两个缩进方法声明的例子；前者是常规情形；后者如使用常规的缩进方式将会使其次行和第三行移得很靠右，所以代之以缩进8个空格；//规范的缩进someMethod〔intanArg,ObjectanotherArg,StringyetAnotherArg,ObjectandStillAnother〕{}//以8个空格来缩进，以防止特殊纵深的缩进privatestaticsynchronizedhorkingLongMethodName〔intanArg,ObjectanotherA

6、rg,StringyetAnotherArg,ObjectandStillAnother〕{}if语句的换行通常使用8个空格的规章，由于常规缩进〔4个空格〕会使语句体看起来比较费劲；比如：//不行取的缩进方法if〔〔condition1&&condition2〕

7、

8、〔condition3&&condition4〕

9、

10、〔condition5&&condition6〕〕{doSomethingAboutIt〔〕;}//可取的缩进方法一if〔〔condition1&&condition2〕

11、

12、〔condition3&&conditin4〕

13、

14、.〔condition5&&condition6〕〕

15、{doSomethingAboutIt〔〕;}//可取的缩进方法二if〔〔condition1&&condition2〕

16、

17、〔conditin3&&condition4〕6/16

18、

19、.〔condition5&&condition6〕〕{doSomethingAboutIt〔〕;}三种可取的三元运算符的缩进格式：alpha=〔aLongBooleanExpression〕.beta:gamma;alpha=〔aLongBooleanE