快捷搜索:  as  test  1111  test aNd 8=8  test++aNd+8=8  as++aNd+8=8  as aNd 8=8

云顶国际在线赌场: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文件,你将看到如下的页面

图 1 JDK的Javadoc文档

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

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

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

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

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

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

·Tree:以层次布局列出包中类继层级关系,经由过程这个列表,可以对类探本溯源,下面是java.applet包Applet类的承袭用实现树。

图 2 以层次布局列出包中的类

·Deprecated:所有过时的类、接口、值域、措施、云顶国际在线赌场构造函数。

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

图 3 以索引要领组织

·Help:关于若何应用Javadoc文档的赞助信息,你可以经由过程这个文档懂得更多应用Javadoc的措施。

每一个类和接口都对应一个Javadoc文档,类和接口云顶国际在线赌场的Javadoc文档所占比云顶国际在线赌场例最大年夜、内容最富厚,它是应用这些类和接口的直接参考文档。因为类比接口包孕了更多的内容,以是我们仅先容类的文档。一个范例的类Javadoc文档包括以下的内容:

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

免责声明:以上内容源自网络,版权归原作者所有,如有侵犯您的原创版权请告知,我们将尽快删除相关内容。

您可能还会对下面的文章感兴趣: