代码编写规范.ppt

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

1、王大刚编码规范1一个软件的生命周期中，80%的花费在于维护几乎没有任何一个软件，在其整个生命同期中，均由最初的开发人员来维护编码规范可以改善软件的可读性，可以让程序员尽快而彻底地理解新代码如果你将源码作为产品发布，就需要确认它是否被很好的打包并且清晰无误，一如你已构建的其它任何产品编码规范的重要性为了执行规范，每个软件开发人员必须一致遵守编码规范。每个人!!!2本文档反映的是SunMicrosystem公司，Java语言规范中的编码标准部分。主要贡献者包括：PeterKing，PatrickNaughton，MikeDeMoney，JonniKanerv

2、a，KathyWalrath以及ScottHommel。版权声明3统一使用eclipse作为开发工具，避免不同的开发工具格式不一样引起的编码混乱4开发工具文件名称第一个字母大写，每个单词的第一个字母大写。代码行不要超过2000行.开头要有注释/**Classname**Versioninformation**Date**Copyrightnotice*/5源文件一个制表符作为缩进排版的一个单位尽量避免一行长度超过80个字符换行。当一个表达式无法容纳在一行内时，可以依据如下一般规则断开之：在一个逗号后面断开在一个操作符前面断开选择较高级别的(higher-

3、level)的断开新行应该与上一行同一级别表达式的开头处对齐如果以上规则导致你的代码混乱或者使你的代码都堆挤在右边，那就代之以缩进8个空格6排版7换行的例子someMethod(longExpression1,longExpression2,longExpression3,longExpression4,longExpression5);var=someMethod1(Expression1,someMethod2(longExpression2,longExpression3));longName1=longName2*(longName3+longN

4、ame4-longNeme5)+4*longName6);privatestaticsynchronizedhorkingLongMethodName(intanArg,ObjectanotherArg,StringyetAnotherArg,ObjectandStillAnother){……}if((condition1&&condition2)

5、

6、(condition3&&condition4)

7、

8、!(condition5&&condition6)){doSomethingAboutIt();}Java程序有两类注释：实现注释(implementat

9、ioncomments)和文档注释(documentcomments)。实现注释是那些在C++中见过的，使用/*…*/和//界定的注释。文档注释(被称为“doccomments”)是Java独有的，并由/**…*/界定。文档注释可以通过javadoc工具转换成HTML文件实现注释用以注释代码或或者实现细节。文档注释从实现自由(implemtentation-free)的角度描述代码的规范。它可以被那些手头没有源码的开发人员读懂注意：频繁的注释有时反映出代码的低质量。当你觉得被迫要加注释的时候，考虑一下重写代码使其更清晰。8注释块注释通常用于提供对文件，方

10、法，数据结构和算法的描述。块注释被置于每个文件的开始处以及每个方法之前块注释之首应该有一个空行，用于把块注释和代码分割开来，比如：/**Hereisablockcomment.*/9块注释短注释可以显示一行内，并与其后的代码具有一样的缩进层级。如果一个注释不能在一行内写完，就用块注释。if(condition){/*Handlethecondition.*/……}10单行注释极短的注释可以与它们所要描述的代码位于同一行，但是应该有足够的空白来分开代码和注释。若有多个短注释出现于大段代码中，它们应该具有相同的缩进。if(a==2){returnTRUE;/

11、*specialcase*/}else{returnisPrime(a);/*worksonlyforodda*/}11尾端注释注释界定符“//”，可以注释掉整行或者一行中的一部分。它一般不用于连续多行的注释文本；if(foo>1){//doadouble-filp……}else{returnfalse;}12行末注释文档注释描述Java的类、接口、构造器、方法，以及字段(field)。每个文档注释都会被置于注释界定符/**…*/之中，一个注释对应一个类、接口或成员。该注释应位于声明之前：/***TheExampleclassprovides…*/pub

12、licclassExample{…13文档注释一行一个声明方法与方法之间以空行分