黄钰-JAVA教学课件 第03章.pptVIP

主要内容 为什么要有规范？ Java程序编写规范 为什么要有规范？ 软件开发是一个集体协作的过程，程序员之间的代码是经常要进行交换阅读的，为了提高java程序的可读性,以及管理上的方便性java源程序有一些约定成俗的命名规定。 优秀的程序代码的标准首先是易于阅读，其次才是效率高低的问题。 Java程序编写规范 有多个import语句时，先写java包（都是java包时，按照字母先后顺序排序），后写javax，最后写其它公司的包和自己定义的包。 命名规则为： 包名中的字母一律小写，xxxyyyzzz。 类名、接口名应该使用名词，每个单词的首字母大写，如XxxYyyZzz。 变量名、方法名第一个字母小写，后面每个单词的首字母大写，如xxxYyyZzz。 常量中的每个字母大写，如XXXYYYZZZ。 Java程序编写规范（Cont） 程序{}强调匹配的同时，要保持适当的缩进，以便于阅读。 必要时应有一定的程序注释量（20％－50％）： 注释内容有：程序头说明，属性说明，方法说明。 Java中的注释共有两种方式 多行注释：/* 文字或程序语句 */ 单行注释：// 文字或程序语句 注意： /* 文字或程序语句 */不能嵌套，即/* /*文字或程序语句*/ */是非法的。 程序中写注释不仅有助记作用，而且还可以利用javadoc生成帮助文档，当然能够生成帮助文档的注释必须具备一定的规则，那就是注释格式必须为： /** 说明信息 */ 生成帮助文档的注释格式 程序头说明：注释符为/** 说明部分 */,在说明部分一般包括文档的标题、描述、版权、作者、版本等信息。其中作者用 “@author 作者”的形式体现，内容和关键字之间用空格隔开。其它为： @version 版本； @see 相关内容或类； @since 本内容在哪个版本以后开始出现。 方法说明：用于说明本方法的主要用途，实现的基本思 路，属性信息有： @param 属性名称 参数说明 ； @return 返回值说明； @exception 例外说明； @throws 异常类 ； @deprecated 功能逐渐被淘汰说明。 程序注释举例 import java.awt.*; import java.applet.*; /** * Title: 这是一个演示程序br * Description:用于说明Applet程序的典型特征br * @author 无名氏 * @version 1.0 */ public class HelloWorldApplet extends Applet { /** 初始化*/ public void init(){} /** 用于绘制界面 * @param g 为内部对象 * @return void */ public void paint(Graphics g) { g.drawString(Hello World!,25,25); } } 程序说明： br的含义是在生成的html中换行；而@author不用写br的原因是，这种属性可以自动换行。 javadoc -d HelloWorldDoc -version -author HelloWorldApplet.java-d的含义是将所有生成的帮助文件全部放入本目录下的子目录HelloWorldDoc下， -version和-author是在帮助文件中列出相关的这方面信息。 如果想知道更多javadoc，输入javadoc –help。 * 第三章 Java程序工程规范 Java程序编写规范