java编程规范(10页)免费下载.pdf

《java编程规范(10页)免费下载.pdf》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、1.1Java编程规范本编程规范建立在标准的Java编程规范的基础上，如和标准的Java编程规范有冲突，以本编程规范为准。1.1.1程序结构包名引入包/类名类注释类常量//常量注释构造器注释构造器构造器注释构造器方法注释方法方法注释方法1.1.2命名规范命名规范使得程序更易理解，可读性更强。并且能够提供函数和标识符的信息。¢文件命名规范java程序使用如下的文件名后缀：文件类型后缀Java源文件.javaJava字节码文件.class对系统的文件命名方式有待于根据实际业务决定。¢包命名规范包名应该唯一，它的前缀可以为任何小写的ASCII字符但必须是顶级域名，目前包括com,edu,gov

2、,mil,net,org,或者ISO标准3166,1981中两个字符的国别代码。包名接下来的部分按照公司内部的命名规范，这些规范指出了某种目录名，主要包括部门，项目，机器，或者登录名。命名规则为：com.sinosoft.系统名[.模块名].xxx.xxx具体参错误！未找到引用源。包命名举例：com.sinosoft.platform.bl.facadecom.sinosoft.platform.dto.domain¢类命名规范类名应该是名词，并且是大小写混合的。首字母要大写。尽量保证类名简单并且描述性强。避免使用只取单词首字母的简写或者单词的缩写形式，除非缩写形式比单词的完整形式更常用

3、（例如：URL或者HTML）。文件名必须和public的类名保持一致，注意大小写（JBuilder等一些编译器可以忽略大小写，要特别注意）.类命名举例：classPolicyOverviewDto;classDBPrpDuser.java;¢接口命名规范www.17jzw.com接口命名方式与类命名方式相同。接口命名举例：interfacePolicyOverview;interfacePolicyOverviewSessionHome;¢方法命名规范方法名应该为动词，并且是大小写混合的。首字母要小写，方法名的第www.17bzw.cn二个单词的第一个字母大写。方法命名举例：String

4、getNoticeNo();CollectionfindByCondition(String)¢变量命名规范变量，以及所有的类实例应为首字母小写的大小写混合形式。变量名的第二个单词的首字母大写。变量名的首字母不能为下划线或者$符。www.17jzw.net变量名应该尽可能的短小，但要有意义。变量名应该便于记忆，也就是说变量名应该尽可能的做到见名知意。除了暂时使用的变量外（一般用于循环变量），应该避免使用只有一个字母的变量名。对于临时变量一般说来：i，j，k，m，n代表整型变量。c，d，e代表字符型变量。变量命名举例：StringdataType;www.17jzw.cnStringnam

5、e;inti;charc;¢常量命名规范声明为类常量的变量或者ANSI常量应该全部为大写字母，并且每个单词间用下划线“_”隔开。为了便于调试，应避免使用ANSI常量。常量命名举例：staticfinalintMIN_WIDTH=4;标准资料收藏家www.17bzw.cn易启标准网免费提供十万标准书籍资料下载会打字、5分钟快速自助建网站www.17jzw.com易启建站网免费提供建站平台，商业网站1年仅60元1.1.3注释规范Java提供了两种类型的注释：程序注释和文档注释。程序注释是由分隔符/*…*/，和//隔开的部分，这些注释和C++中的注释一样。文档注释（即“doc注释”）是Java

6、独有的。由分隔符/**…*/隔开。使用javadoc工具能够将文档注释抽取出来形成HTML文件。程序注释主要是对程序的某部分具体实现方式的注释。文档注释是对程序的描述性注释，主要是提供给不需要了解程序具体实现的开发者使用。注释应该是代码的概括性描述，提供不易直接从代码中得到的信息，并且只包含对阅读和理解程序有用的信息。例如注释中包含相应的包如何编译或者在哪个目录下，而不应该包括这个包驻留在哪儿的信息。注释中可以描述一些精妙的算法和一些不易理解的设计思想，但应该避免那些在程序代码中很清楚的表达出来的信息。尽可能的避免过时的信息。错误的注释比没有注释更有害。经常性的注释有时也反映出代码质量的

7、低下。¢程序注释程序注释有四种格式：块注释格式，单行注释，跟随注释，行尾注释¾块注释格式块注释主要用于描述：文件、方法、数据结构和算法。一般在文件或者方法定义的之前使用。也可以用在方法定义里面，如果块注释放在函数或者方法定义里，它必须与它所描述的代码具有相同的缩进形式。块注释应该用一个空行开头，以便于代码部分区分开来。块注释举例：/**Hereisablockcomment.*/¾单行注释比较短的注释可以放在一行中，但必须与它所跟随