JBuilder2005建设开拓文档之Javadoc
副标题#e#
固然软件工程中把具体设计作为软件项目标一个重要的阶段，但在实践中往往没有获得落实。并不是这个阶段不重要，而是实施有很大的坚苦，因为软件需求是天生的易动症患者，好不容易具体设计出来后，需求已和当初的版本截然不同，而耗费庞大，精雕细琢的具体设计已酿成昨日黄花了。另一方面，有一些成果实现往往要比及真正编码时才气想到更好的要领，究竟设计时是"凭梦想象"，而编码时才是"实践操纵"，所以在编码时对原设计举办调解经常在所不免。
具体设计文档是源代码实现上的描写，但在物理上则是和源代码文件疏散的，两者间的一致性很容易被冲破，维持两者一致性价钱经常是项目正常周期无法遭受的。各类"自文档"或"直接文档"的技能应运而生，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 以索引方法组织
#p#副标题#e#
·Help：关于如何利用Javadoc文档的辅佐信息，你可以通过这个文档相识更多利用Javadoc的要领。
每一个类和接口都对应一个Javadoc文档，类和接口的Javadoc文档所占比例最大、内容最富厚，它是利用这些类和接口的直接参考文档。由于类比接口包括了更多的内容，所以我们仅先容类的文档。一个典范的类Javadoc文档包罗以下的内容：
·导航条：在文档头部和尾部都有导航条，利便快速链接到常用的页面，提供了上一页和下一页的链接，而且提供了在定位到本页中差异部门的锚链接。
·类的担任干系：类的担任树，类实现的接口以及类的子类。通过这些信息可以从纵向相识类的关联干系。
·类的扼要说明：类的扼要描写信息，描写类的坚守。
·内部类的列表：列出类中所界说的内部类。
·类值域摘要：所有的protected和public的值域，每个值域对应一句说明。
·类结构要领摘要：所有的protected和public的成员结构要领，每个结构要领对应一句说明。
·类成员要领摘要：所有的protected和public的成员要领，每个要领对应一句说明。
·类担任要领列表：承继父类要领的列表。
·类值域具体说明：protected和public的值域的具体说明及关联链接。
·类结构要领具体说明：protected和public的结构要领的具体说明，要领入参、返回值、抛出异常说明及关联链接。
·类成员要领具体说明：protected和public的成员要领的具体说明，要领入参、返回值、抛出异常说明及关联内容的链接。
JBuilder提供了很多支持Javadoc的成果，这些成果包罗：
·可通过快捷键建设类、接口、要领、值域及结构函数的注释布局体，注释布局体中包括了和源码对应的标签。
·诱导录入Javadoc标签的JavadocInsight。
·可通过快捷键添加@todo标签并可以欣赏这些标签。
·陈诉并修复和源代码斗嘴的Javadoc注释。
·通过Archiver Builder建设整个工程的Javadoc文档。
·建设自界说的Javadoc标签
·用Doc欣赏器欣赏措施文件的Javadoc文档
