<b>JBuilder2005成立开辟文档之Javadoc</b>[Java编程]

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

具体计划文档是源代码实现上的描写,但在物理上则是和源代码文件别离的,二者间的一致性很简单被冲破,保持二者一致性代价常常是项目正常周期无法承受的.各种"自文档"或"直接文档"的技术应运而生,Javadoc就是Java的自文档技术,即通过"寄生"在源代码文件中的注释信息产生帮忙文档,这种帮忙文档本身也就是具体计划文档.由于程序代码和注释信息在同一个文件中,在更改程序时呼应调整注释则是举手之劳的事,二者间的一致性很简单得到保障.

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

图1 JDK的Javadoc文档

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

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

·Overview:全部包的阐明列表,每个包对应表中一行阐明.

·Package:包中全部类或接口的阐明列表,每个类或接口对应表中一行阐明.

·Class:标明为当前类,其上并没有链接.

·Use:类的全部关联类:包含担当关系,依靠关系,关联关系等.

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

图2 以层次构造列出包中的类

·Deprecated:全部过期的类、接口、值域、办法、构造函数.

·Index:索引页面,将JDK中全部的类、接口、常量、办法都以字母次序举行索引,借此页面可以快速定位到所需的帮忙内容,其页面以下:

图3 以索引方法组织

　　以上是“<b>JBuilder2005成立开辟文档之Javadoc</b>[Java编程]”的内容，如果你对以上该文章内容感兴趣，你可以看看七道奇为您推荐以下文章：