java开发代码规约

《java开发代码规约》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、以下是JavaCoding规范，请大家必须遵照执行。JavaSource描述风格2009.7.1概括了Ｓｕｎ所定义的描述风格，并追加了一部分内容。1文件名SourceFile・ClassFile的扩展名如下所示：文件种类扩展名SourceFile.javaClassFile.class另外，关于特定目录下的文件，需要另外说明的情况下，在“README”文本文件中进行描述。1SourceFile各自的JavaSourceFile均包含一个publicclass或者Interface。当privateCla

2、ss以及Interface与publicclass被联系起来的情况下，privateClass也可以描述到与publicclass相同的文件中。publicclass必须在文件的最开始处进行描述。一个SourceFile按照以下顺序进行描述。ØSourceFile开始CommentØpackage声明语句Øimport声明语句ØClass／Interface的Code2.1SourceFile开始Comment所有的SourceFile文件中通过C语言的comment来描述Class名・版本信息・日期・

3、著作权。/Title：说明：Copyright显示变更履历：yyyy/mm/dd啊啊啊啊啊啊啊啊yyyy/mm/dd鹅鹅鹅鹅鹅鹅鹅鹅yyyy/mm/dd人人人人人人人人/2.2package声明语句Ø均用小写字母表示。Ø开头按照逆顺序记录InternetDomain。（TDC为cn.com.tdc）2.3import声明语句按照以下顺序进行描述。1.java.2.javax.3.org.w3c.dom.4.jp.co.tdc.2.1Class／Interface的CodeClass以及Interface

4、的Code按照以下顺序进行描述。Document用Comment（/../）描述能通过javadoc被处理的Comment。→详细class或者interface的声明 代码注释（/.../）描述不能通过javadoc被处理的Comment。是对不写在Document用Comment中更好的编码说明的一种描述。Class变量按照「public」「protected」「private」的顺序进行声明。Interface变量Constructor先描述参数较少的部分。InstanceMethod按照相似的功

5、能逐一地进行总结、描述。相同名称的Method，要先描述参数较少的部分。classMethod（staticMethod）按照相似的功能逐一地进行总结、描述。相同名称的Method，先描述参数较少的部分。2缩进Ø每行开头开始的缩进使用ＴＡＢ字符来进行。Ø其它的缩进按照空格８个字符的单位来进行。Ø每1行设定为不超过100个字符。1行超过100个字符时，按照以下规则进行换行。Ø在逗号后面换行。Ø在运算符的前面换行。Ø优先较高级别的描述引起的换行。Ø上一行相同级别的描述与下一行的开头部分相吻合。Ø按照以上规则

6、所写编码难以理解的情况下，加上只有8个空格的缩进。范例：「>」＝ＴＡＢ字符「_」＝空格例１．>xxxxxxxxxxMethod(aaaaaaaaaa,bbbbbbbbbb,cccccccccc,dddddddddd,>________eeeeeeeeee);/缩进８个字符/例２．>xxxxxxxxxxMethod(aaaaaaaaaa,>________yyyyyyyyyyMethod(bbbbbbbbbb,>________________cccccccccc));/再缩进８个字符/例３．>if((a

7、aaaaaaaaa&&bbbbbbbbbb)>________(cccccccccc&&dddddddddd)>________!(eeeeeeeeee&&ffffffffff)){/按照相同级别对齐/>_________________________________________/Comment也通过空格对齐/>}2注释注释分为阅读代码时提供帮助的【编码注释】和通过Javadoc命令自动生成API文档的【文档用注释】两种。2.1编码注释编码注释分为【块注释】，【单行注释】，【拖后注释】，【行末注释

8、】四种。2.1.1块注释描述跨越多行的注释。/块注释块注释/Ø描述File，Method，数据结构，算法等。Ø也可以在File的开头或者Method的中间进行描述。Ø缩进要与对象代码相同。Ø紧跟在块注释的前面插入空行。2.1.2单行注释在对象代码的某行之前进行描述的简短注释。if(xxx){/单行注释/xxxMethod(yyy);}Ø缩进要与对象代码相同。Ø两行以上时，就还是使用块注释。Ø紧跟在单行注释之前，插入空行。2.1.3拖后注释在