苏州科技大学数理学院面向对象的分析与设计课件 第15讲.ppt

Sun公司推荐的java编码规范 3.1.1 开头注释(Beginning Comments) 所有的源文件都应该在开头有一个C语言风格的注释，其中列出数出类名、版本信息，日期和版权声明： / * * Classname * * Version information * * Date * * Copyright notice * / 我们的进度，在这里 Sun公司推荐的java编码规范 3.1.2 包和引入(Package and Import Statements) 在多数Java源文件中，第一个非注释行是包语句行。在它之后可以跟引入语句。例如： package java.awt; import java.awt.peer.CanvasPeer; 我们的进度，在这里 Sun公司推荐的java编码规范 3.1.3 类和接口声明(Class and Interface Declarations) 下表描述了类和接口声明的免修部分以及它们出现的先后次序。参见“Java源文件范例”中一个包含注释的例子。 我们的进度，在这里 Sun公司推荐的java编码规范 类/接口声明的各部分 注解 1 类/接口文档注释 (/ **…* /) 该注释中所包含的信息，参见“文档注释” 2 类/接口的声明 3 类/接口实现的注释 (/ *…* /) 如果有必要的话 该注释应包含任何有关整个类或接口的信息，而这些信息又适合作为类/接口文档注释。 4 类的(静态)变量 首先是类的public变量，随后是protected变量，再后是包一级别的变量(没有访问修饰符)，最后是private变量。 5 实例变量 首先是public变量，随后是protected变量，再后是包一级别的变量(没有访问修饰符)，最后是private变量。 6 构造器 7 方法 这些方法应该按功能，而非作用域或访问权限，分组。 我们的进度，在这里 Sun公司推荐的java编码规范 4.1 行长度 尽量避免一行长度超过80个字符，因为很多终端和工具不能很好处理之。注意：用于文档是的例子应该使用更短的行长，长度一般不超过70个字符。 4.2 换行(Wrapping Lines) 当一个表达式无法容纳在一行内时，可以依据如下一般规则断开之： ◆ 在一个逗号后面断开。 ◆ 在一个操作符前面断开。 ◆ 宁可选择较高级别的(higher-level)的断开，而非较低级别(lower-level)的断开。 ◆ 新的一行应该与上一行同一级别表达式的开头处对齐。 ◆ 如果以上规则导致你的代码混乱或者使你的代码都堆挤在右边，那就代之以缩进8个空格。 我们的进度，在这里 Sun公司推荐的java编码规范 以下是两个断开算术表达式的例子。前者更好，因为断开处位于括号表达式的外边，这是个较高级别的断开。 longName1 = longName2 * (longName3 + longName4- longNeme5) + 4 * longName6); //PREFFER longName1 = longName2 * (longName3 + longName4 - longName5) + 4 * longName6; //AVOID 我们的进度，在这里 Sun公司推荐的java编码规范 Java程序有两类注释： 实现注释(implementation comments)和文档注释(document comments)。 实现注释是那些在C++中见过的，使用/*…*/和//界定的注释。文档注释(被称为“doc comments”)是Java独有的，并由/**…*/界定。文档注释可以通过javadoc工具转换成HTML文件。 实现注释用以注释代码或或者实现细节。文档注释从实现自由(implemtentation-free)的角度描述代码的规范。它可以被那些手头没有源码的开发人员读懂。 我们的进度，在这里 Sun公司推荐的java编码规范 注释应被用来给出代码的总括，并提供代码自身没有提供的附加信息。注释应该仅包含与阅读和理解程序有关的信息。例如，相应的包如何被建立或位于哪个目录下之类的信息不应包括在注释中。 在注释里，对设计决策中重要的或者不是显而易见的地方进行说明是可以的，但应避免提供代码中已清晰表达出来的重复信息，多余的注释很容易过时。通常应避免那些代码更新就可能过时的注释。 注意：频繁的注释有时反映出代码的低质量。当你觉得被迫要加注释的时候，考虑一下重写代码使其更清晰。 注释不应写在用星号或字符画出来的大框里。注释不应包括诸如制表符和回退符之类 的特殊字符。 我们的进度，在这里 实验报告封面写法 课程名称：软件工程与UML 指导教师：林琳 系