Java程序工程规范.doc

PAGE 40 Java面向对象程序设计 PAGE 39 第3章  STYLEREF 标题 1,章,章名,实例名称 \* MERGEFORMAT Error! No text of specified style in document. 第 3 章 Java程序工程规范 3.1 为什么要有规范 软件开发是一个集体协作的过程，程序员之间的代码经常进行交换阅读，因此，Java源程序有一些约定俗成的命名规定，主要目的是为了提高Java程序的可读性以及管理上的方便性。好的程序代码应首先易于阅读，其次才是效率高低的问题。 3.2 Java程序编程规范 （1）有多个import语句时，先写java包（都是java包时，按照字母先后顺序排序），后写javax，最后写其他公司的包和自己定义的包。 （2）命名规则为： 包名中的字母一律小写，xxxyyyzzz。 类名、接口名的每个单词的首字母大写，如XxxYyyZzz。 方法名第一个单词的首字母小写，后面每个单词的首字母大写，如xxxYyyZzz。 常量中的每个字母大写，如XXXYYYZZZ。 （3）程序{}强调匹配的同时，要保持适当的缩进，以便于阅读。 （4）必要时应有一定的程序注释量（20％～50％），注释内容有程序头说明、属性说明、方法说明。Java中的注释共有两种方式。 多行注释：/* 文字或程序语句 */。 单行注释：// 文字或程序语句。 ref SHAPE \* MERGEFORMAT 注意 多行注释不能嵌套，即/* /*文字或程序语句*/ */是非法的。 3.3 帮助文档的自动生成 Java工程规范一方面体现在程序上，另一方面体现在程序帮助文档上，文档的规范和程序的规范同等重要。文档规范要求必须具备一定的书写格式以及与程序保持一致。然而，要真正实现这一目标并不容易，因为一定的书写格式虽然便于人们之间的沟通，但是却消耗了程序员宝贵的时间；文档与程序保持一致也并不容易，因为程序可能会经常修改，这种修改并不都能及时反映到文档中。 要解决上述问题，没有一定的工具是不可能做到的，Sun公司提供的工具javadoc就是解决这样的问题，javadoc工具的引入，将程序员从枯燥然而又重要的工作中解放出来。程序员只要在书写程序时按照一定的要求书写注释，将来就可用javadoc自动生成帮助文档。程序员需要注意的规则如下： （1）程序头说明 注释为“/** 说明部分 */”,在说明部分一般包括文档的标题、描述、版权、作者、版本等信息。其中作者用 “@author 作者”的形式体现，内容和关键字之间用空格隔开。其他为@version 版本、@see 相关内容或类、@since 本内容在哪个版本以后开始出现。 （2）方法说明 用于说明本方法的主要用途，实现的基本思路，属性信息有@param 属性名称 参数说明、@return 返回值说明、@exception 例外说明、@throws 异常类、@deprecated 功能逐渐被淘汰说明。 如果按照上面的方式书写注释，则它们可以反映到帮助文档中。 【例3.1】 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 为内部对象 */ public void paint(Graphics g) { g.drawString(Hello World!,25,25); } } ref SHAPE \* MERGEFORMAT 程序说明 br的含义是在生成的html中换行；而@author后不用写br的原因是这种属性可以自动换??。 使用javadoc工具按照如下方式书写并执行： javadoc -d HelloWorldDoc -version -author HelloWorldApplet.java 其中，–d的含义是将所有生成的帮助文件全部放入本目录的子目录HelloWorldDoc下， –version和–author是在帮助文件中列出相关的这方面信息。选择生成的index.html如图3.1所示。 ref SHAPE \* MERGEFORMAT 注意 如果想知道更多javadoc，请输入javadoc –