java编码规范及注释快捷键.doc

《java编码规范及注释快捷键.doc》由会员上传分享，免费在线阅读，更多相关内容在应用文档-天天文库。

1、3文件组织(FileOrganization)一个文件由被空行分割而成的段落以及标识每个段落的可选注释共同组成。超过2000行的程序难以阅读，应该尽量避免。"Java源文件范例"提供了一个布局合理的Java程序范例。3.1Java源文件(JavaSourceFiles)每个Java源文件都包含一个单一的公共类或接口。若私有类和接口与一个公共类相关联，可以将它们和公共类放入同一个源文件。公共类必须是这个文件中的第一个类或接口。Java源文件还遵循以下规则：-开头注释（参见"开头注释"）-包和引入语句（参见"包和引入语句"）-类和接口声明（

2、参见"类和接口声明"）3.1.1开头注释(BeginningComments)所有的源文件都应该在开头有一个C语言风格的注释，其中列出类名、版本信息、日期和版权声明：/**Classname**Versioninformation**Date**Copyrightnotice*/3.1.2包和引入语句(PackageandImportStatements)在多数Java源文件中，第一个非注释行是包语句。在它之后可以跟引入语句。例如：packagejava.awt;importjava.awt.peer.CanvasPeer;Addimp

3、ort:Ctrl+Shift+M3.1.3类和接口声明(ClassandInterfaceDeclarations)类/接口声明的各部分注解1类/接口文档注释(/**……*/)该注释中所需包含的信息，参见"文档注释"2类或接口的声明3该注释应包含任何有关整个类或接口的信息，而这些信息又不适合作为类/接口文档注释。类/接口实现的注释(/*……*/)如果有必要的话4类的(静态)变量首先是类的公共变量，随后是保护变量，再后是包一级别的变量(没有访问修饰符，accessmodifier)，最后是私有变量。5实例变量首先是公共级别的，随后是保护级

4、别的，再后是包一级别的(没有访问修饰符)，最后是私有级别的。6构造器7方法这些方法应该按功能，而非作用域或访问权限，分组。例如，一个私有的类方法可以置于两个公有的实例方法之间。其目的是为了更便于阅读和理解代码。方法的注释：声明好方法后，在向方法里写实现的代码前，在方法前/**+回车键，就行了，如果方法实现了，这个则不起效果下面的例子，展示了如何合理布局一个包含单一公共类的Java源程序。接口的布局与其相似。/**@(#)Blah.java1.8299/03/18**Copyright(c)1994-1999SunMicrosystems

5、,Inc.*901SanAntonioRoad,PaloAlto,California,94303,U.S.A.*Allrightsreserved.**ThissoftwareistheconfidentialandproprietaryinformationofSun*Microsystems,Inc.("ConfidentialInformation").Youshallnot*disclosesuchConfidentialInformationandshalluseitonlyin*accordancewiththeterms

6、ofthelicenseagreementyouenteredinto*withSun.*/packagejava.blah;importjava.blah.blahdy.BlahBlah;/***Classdescriptiongoeshere.**@version1.8218Mar1999*@authorFirstnameLastname*/publicclassBlahextendsSomeClass{/*Aclassimplementationcommentcangohere.*//**classVar1documentatio

7、ncomment*/publicstaticintclassVar1;/***classVar2documentationcommentthathappenstobe*morethanonelinelong*/privatestaticObjectclassVar2;/**instanceVar1documentationcomment*/publicObjectinstanceVar1;/**instanceVar2documentationcomment*/protectedintinstanceVar2;/**instanceVa

8、r3documentationcomment*/privateObject[]instanceVar3;/***...constructorBlahdocumentationcomment...*/publ