疯狂java


您现在的位置: 疯狂软件 >> 新闻资讯 >> 正文

Java文档注释(3)—[疯狂java讲义]


 

       如果单击“类列表区”里列出的某个类,将看到右边变成如图3.3所示的格局:
在图3.3所示页面中,因为我们单击了左边类列表区的Button类,因此看到右边显示了Button类的详细信息,这些信息是使用Button类的重要资料。接着把图3.3所示窗口右边的滚动条向下滚动,将在“详细说明区”看到如图3.4所示的格局:
图3.3 类说明区格局
图3.4 类说明区格局
从图3.4所示的类说明区中可以看出,API文档里详细列出了该类里包含的所有成分,通过查看该文档,开发者就可以掌握该类的用法。图3.4所看到的内部类列表、属性列表、构造器列表和方法列表只给出了一些简单描述,如果开发者需要获得更详细的信息,则可以单击具体内部类、属性、构造器和方法的链接,从而看到对应项的详细用法说明。
对于内部类、属性、方法列表区,都可以分为左右两个,其中左边一个是该项的修饰符、类型说明,右边一格是该项的简单说明。
同样,我们在开发中定义类、方法时也可以先添加文档注释,然后使用javadoc工具来生成自己的API文档。(未完.摘自[疯狂java讲义].李刚)