设为首页 加入收藏

TOP

JBuilder2005创建开发文档之Javadoc
2014-11-23 19:53:37 】 浏览:7646
Tags:JBuilder2005 创建 开发 文档 Javadoc

  虽然软件工程中把详细设计作为软件项目的一个重要的阶段,但在实践中往往没有得到落实。并不是这个阶段不重要,而是实施有很大的困难,因为软件需求是天生的易动症患者,好不容易详细设计出来后,需求已和当初的版本大相径庭,而花费巨大,精雕细琢的详细设计已变成昨日黄花了。另一方面,有一些功能实现往往要等到真正编码时才能想到更好的方法,毕竟设计时是"凭空想象",而编码时才是"实践操作",所以在编码时对原设计进行调整常常在所难免。


  详细设计文档是源代码实现上的描述,但在物理上则是和源代码文件分离的,两者间的一致性很容易被打破,维持两者一致性代价常常是项目正常周期无法承受的。各种"自文档"或"直接文档"的技术应运而生,Javadoc就是Java的自文档技术,即通过"寄生"在源代码文件中的注释信息产生帮助文档,这种帮助文档本身也就是详细设计文档。由于程序代码和注释信息在同一个文件中,在更改程序时相应调整注释则是举手之劳的事,两者间的一致性很容易得到保障。


  作为一名Java程序员,想必多少看过JDK的API帮助文档,JBuilder自带的JDK1.4的帮助文档位于 /doc/jdk_docs.jar,它包含了JDK的Javadoc文档,你可以通过诸如winRAR等解压软件将jdk_doc.jar解压到某个目录下,解压后jdk_docs/java/api目录中的文档就是JDK的Javadoc文档。双击打开目录下的index.html文件,你将看到如下的页面


  网页分为三个帧,左上角的帧是包的列表,左下角的帧是包中类的列表,而右边主窗口帧是类的API说明页面。


  类API说明页面顶部有一个导航条,方便链接到一些常用的页面,这些常见的页面包括:


  ·Overview:所有包的说明列表,每个包对应表中一行说明。


  ·Package:包中所有类或接口的说明列表,每个类或接口对应表中一行说明。


  ·Class:标明为当前类,其上并无链接。


  ·Use:类的所有关联类:包括继承关系,依赖关系,关联关系等。


  ·Tree:以层次结构列出包中类继层级关系,通过这个列表,可以对类探本溯源,下面是java.Applet包Applet类的继承用实现树。


  ·Deprecated:所有过期的类、接口、值域、方法、构造函数。


  ·Index:索引页面,将JDK中所有的类、接口、常量、方法都以字母顺序进行索引,借此页面可以快速定位到所需的帮助内容,其页面如下:


  ·Help:关于如何使用Javadoc文档的帮助信息,你可以通过这个文档了解更多使用Javadoc的方法。


】【打印繁体】【投稿】【收藏】 【推荐】【举报】【评论】 【关闭】 【返回顶部
上一篇Eclipse远程调试Weblogic运行的源.. 下一篇在Eclipse中使用SWT进行界面设计

最新文章

热门文章

Hot 文章

Python

C 语言

C++基础

大数据基础

linux编程基础

C/C++面试题目