《编程规范介绍》ppt课件模板.pptVIP

Add the author and the accompanying title;编程规范介绍;此文档后面有赠送常用PPT图标，方便大家修订排版编辑;;四、文件组织() 1 、Java源文件(Java Source Files) 每个Java 源文件都包含一个单一的公共类或接口。若私有类和接口与 一个公共类相关联，可以将它们和公共类放入同一个源文件。公共类必须 是这个文件中的第一个类或接口。 Java 源文件还遵循以下规则： - 开头注释 - 包和引入语句 类和接口声明 2 、开头注释(Beginning Comments) 所有的源文件都应该在开头有一个注释，其中列出类名、版本信息、 日期和版权声明，其格式如下： ;/** * @(#)$CurrentFile * 版权声明XXXXXX 公司，版权所有违者必究 * *br Copyright：Copyright (c) 2011 *br Company：Arvato *br @author Kevin（电子邮箱地址） *br 2011-06-04 *br @version 1.0 */ 3 、包和引入语句(Package and Import Statements) 在多数Java 源文件中，第一个非注释行是包语句。在它之后可以跟引 入语句。示例： package java.awt; import java.awt.peer.CanvasPeer; 4 、类和接口声明(Class and Interface Declarations) 下表描述了类和接口声明的各个部分以及它们出现的先后次序。;;5 、缩进排版(Indentation) 4 个空格常被作为缩进排版的一个单位。缩进的确切解释并未详细指 定(空格vs. 制表符)。一个制表符等于8 个空格(而非4 个)。 行长度(Line Length) 尽量避免一行的长度超过80 个字符，因为很多终端和工具不能很好处理之。 注意：用于文档中的例子应该使用更短的行长，长度一般不超过70个字符。 换行(Wrapping Lines) 当一个表达式无法容纳在一行内时，可以依据如下一般规则断开之： 1、 在一个逗号后面断开 ； 2、在一个操作符前面断开 以下是断开方法调用的示例： someMethod(longExpression1, longExpression2, longExpression3, longExpression4, longExpression5); longName1 = longName2 * (longName3 + longName4 - longName5) + 4 * longname6;;6、 注释(Comments) Java 程序有两类注释：实现注释(implementation comments)和文档注释 (document comments)。 实现注释：是那些在使用/*...*/和//界定的注释。 ???档注释(被称为doc comments)：是Java 独有的，并由/**...*/界定。 文档注释可以通过javadoc 工具转换成HTML 文件。 实现注释的格式(Implementation Comment Formats) 程序可以有4 种实现注释的风格： 1）块(block)； 2）单行(single-line)； 3）尾端(trailing)； 4）行末(end-of-line)；;块注释(Block Comments) 块注释通常用于提供对文件，方法，数据结构和算法的描述。块注释 被置于每个文件的开始处以及每个方法之前。它们也可以被用于其他地 方，比如方法内部。在功能和方法内部的块注释应该和它们所描述的代码 具有一样的缩进格式。 块注释之首应该有一个空行，用于把块注释和代码分割开来，比如： /* * 这里是具体注释内容. */ 单行注释(Single-Line Comments) 短注释可以显示在一行内，并与其后的代码具有一样的缩进层级。如 果一个注释不能在一行内写完，就该采用块注释。单行注释之前应该有一 个空行。示例：if (condition) { /* 这里是单行注释. */ ... };尾端注释(Trailing Comments) 极短的注释可以与它们所要描述的代码位于同一行，但是应该有足够 的空白来分开代码和注释。若有多个短注释出现于大段代码中，它们应该 具有相同