分享
 
 
 

JBuilder2005创建开发文档之Javadoc

王朝java/jsp·作者佚名  2006-11-24
窄屏简体版  字體: |||超大  

虽然软件工程中把具体设计作为软件项目的一个重要的阶段,但在实践中往往没有得到落实。并不是这个阶段不重要,而是实施有很大的困难,因为软件需求是天生的易动症患者,好不轻易具体设计出来后,需求已和当初的版本大相径庭,而花费巨大,精雕细琢的具体设计已变成昨日黄花了。

另一方面,有一些功能实现往往要等到真正编码时才能想到更好的方法,究竟设计时是"凭空想象",而编码时才是"实践操作",所以在编码时对原设计进行调整经常在所难免。

具体设计文档是源代码实现上的描述,但在物理上则是和源代码文件分离的,两者间的一致性很轻易被打破,维持两者一致性代价经常是项目正常周期无法承受的。各种"自文档"或"直接文档"的技术应运而生,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 以索引方式组织

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

每一个类和接口都对应一个Javadoc文档,类和接口的Javadoc文档所占比例最大、内容最丰富,它是使用这些类和接口的直接参考文档。由于类比接口包含了更多的内容,所以我们仅介绍类的文档。一个典型的类Javadoc文档包括以下的内容:

·导航条:在文档头部和尾部都有导航条,方便快速链接到常用的页面,提供了上一页和下一页的链接,并且提供了在定位到本页中不同部分的锚链接。

·类的继续关系:类的继续树,类实现的接口以及类的子类。通过这些信息可以从纵向了解类的关联关系。

·类的简要说明:类的简要描述信息,描述类的功用。

·内部类的列表:列出类中所定义的内部类。

·类值域摘要:所有的protected和public的值域,每个值域对应一句说明。

·类构造方法摘要:所有的protected和public的成员构造方法,每个构造方法对应一句说明。

·类成员方法摘要:所有的protected和public的成员方法,每个方法对应一句说明。

·类继续方法列表:承继父类方法的列表。

·类值域具体说明:protected和public的值域的具体说明及关联链接。

 
 
 
免责声明:本文为网络用户发布,其观点仅代表作者个人观点,与本站无关,本站仅提供信息存储服务。文中陈述内容未经本站证实,其真实性、完整性、及时性本站不作任何保证或承诺,请读者仅作参考,并请自行核实相关内容。
2023年上半年GDP全球前十五强
 百态   2023-10-24
美众议院议长启动对拜登的弹劾调查
 百态   2023-09-13
上海、济南、武汉等多地出现不明坠落物
 探索   2023-09-06
印度或要将国名改为“巴拉特”
 百态   2023-09-06
男子为女友送行,买票不登机被捕
 百态   2023-08-20
手机地震预警功能怎么开?
 干货   2023-08-06
女子4年卖2套房花700多万做美容:不但没变美脸,面部还出现变形
 百态   2023-08-04
住户一楼被水淹 还冲来8头猪
 百态   2023-07-31
女子体内爬出大量瓜子状活虫
 百态   2023-07-25
地球连续35年收到神秘规律性信号,网友:不要回答!
 探索   2023-07-21
全球镓价格本周大涨27%
 探索   2023-07-09
钱都流向了那些不缺钱的人,苦都留给了能吃苦的人
 探索   2023-07-02
倩女手游刀客魅者强控制(强混乱强眩晕强睡眠)和对应控制抗性的关系
 百态   2020-08-20
美国5月9日最新疫情:美国确诊人数突破131万
 百态   2020-05-09
荷兰政府宣布将集体辞职
 干货   2020-04-30
倩女幽魂手游师徒任务情义春秋猜成语答案逍遥观:鹏程万里
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案神机营:射石饮羽
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案昆仑山:拔刀相助
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案天工阁:鬼斧神工
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案丝路古道:单枪匹马
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案镇郊荒野:与虎谋皮
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案镇郊荒野:李代桃僵
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案镇郊荒野:指鹿为马
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案金陵:小鸟依人
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案金陵:千金买邻
 干货   2019-11-12
 
推荐阅读
 
 
 
>>返回首頁<<
 
靜靜地坐在廢墟上,四周的荒凉一望無際,忽然覺得,淒涼也很美
© 2005- 王朝網路 版權所有