《Java程序工程规范》PPT课件.ppt

,第三章 Java程序工程规范,主要内容,3.1 为什么要有规范 3.2 Java程序编程规范 3.3 帮助文档的自动生成,3.1 为什么要有规范,好的编码规范可以尽可能的减少一个软件的维护成本 , 并且几乎没有任何一个软件，在其整个生命周期中，均由最初的开发人员来维护； 好的编码规范可以改善软件的可读性，可以让开发人员尽快而彻底地理解新的代码； 好的编码规范可以最大限度的提高团队开发的合作效率； 长期的规范性编码还可以让开发人员养成好的编码习惯，甚至锻炼出更加严谨的思维；,3.2 Java程序编程规范,Java源文件 每个Java源文件都包含一个单一的公共类或接口。若私有类和接口与一个公共类相关联，可以将它们和公共类放入同一个源文件。公共类必须是这个文件中的第一个类或接口。,一个Java源文件包含以下部分 开头注释 包和引入语句 类和接口的声明,开头注释 所有的源文件都应该在开头有一个注释，列出类名、版本信息、日期和版权声明 /* * Classname * Version information * Date * Copyright notice */,包和引入语句 在多数Java源文件中，第一个非注释行是package语句，用于说明类所属的包，至多只有一句。 import语句声明引入程序需要的类，可以有若干句或没有。先写java包（都是java包时，按照字母先后顺序排序），后写javax，最后写其它公司的包和自己定义的包。 package java.awt; import java.awt.peer.CanvasPeer;,类和接口声明 类/接口文档注释(/*/) 该注释中所需包含的信息 类或接口的声明 类/接口实现的注释(/*/)如果有必要的话 该注释应包含任何有关整个类或接口的信息，而这些信息又不适合作为类/接口文档注释。,类的(静态)变量 首先是类的公共变量，随后是保护变量，再后是包一级别的变量，最后是私有变量。 实例变量 首先是公共级别的，随后是保护级别的，再后是包一级别的(没有访问修饰符)，最后是私有级别的。 构造器 方法 这些方法应该按功能，而非作用域或访问权限分组。,注释 单行注释/ 多行注释/* */ 文档注释/* */,命名规范 一般规则 尽量使用完整的英文描述符 采用适用于相关领域的术语 采用大小写混合使名字可读 尽量少用缩写，但如果用了，必须符合整个工程中的统一定义 避免使用长的名字（小于 15 个字母为正常选择） 避免使用类似的名字，或者仅是大小写不同的名字 避免使用下划线（除静态常量等）,标识符说明 包(Packages) 一个唯一包名的前缀总是全部小写的字母并且是一个顶级域名 类(Classes) 、接口(Interface)命名规则：类名是个一名词，采用大小写混合的方式，每个单词的首字母大写。使用完整单词，避免缩写词 方法(Methods) 方法名是一个动词，采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写,变量(Variables) 除了变量名外，所有实例，包括类，类常量，均采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写。变量名不应以下划线或美元符号开头，尽管这在语法上是允许的。 实例变量(Instance Variables) 大小写规则和变量名相似，除了前面需要一个下划线 常量(Constants) 类常量和ANSI常量的声明，应该全部大写，单词间用下划线隔开,【例3-1】,3.3 帮助文档的自动生成,帮助文档包含的信息 类的继承层次 类和类的一般目的描述 成员变量详细列表及目的和用途的描述 构造方法详细列表及描述 方法详细列表及描述,插入注释 常规注释 since 版本 该标记可以生成一个注释表明这个特性（类、接口、属性或者方法等）是在软件的哪个版本之后开始提供的。 deprecated 类、属性、方法名等 这个标记可以增加一条注释，指出相应的类、方法或者属性不再应该使用。 see 链接 这个标记增加一个超链接,为类和接口添加注释 author 作者名 当使用author标记时，用指定的文本文字在生成的文档中添加“Author”（作者）项。 version 版本 这个标记建议一个“版本”条目，后面的文字可以是当前版本的任意描述,方法注释 return 该方法的返回值 这个标记为当前方法增加一个返回值（“Returns”）小节。 throws 该方法抛出的异常 这个标记为当前方法在“Throws”小节添加一个条目，并会自动创建一个超级链接。一个方法的所有throws都必须放在一起 param 变量描述 当前方法需要的所有参数，都需要用这个标记进行解释，并且这些标记都应该放在一起。,包和综述注释 为了生成一个包的注释，必须在每个包的目录下放置一个名为package.html的文件来对包进行描述。标签之间的文字都会被javadoc自动提取出来。也可以为所有源文件提供一个综述注释，写入名为overview.html文件中，将其放在所有源文件所在的父目录下面。标签 之间的文字也都会被javadoc自动提取出来，做成文档的Overview,提取程序文档 javadoc options packagename sourcefiles files 例： javadoc -d HelloWorldDoc -version -author He