閺€鎯版 (0) +1 鐠э拷 (0) +1 闊拷 (0) +1
閺€鎯版閹存劕濮�閺屻儳婀呴弨鎯版>>
0

正在阅读:Java咖啡馆(4)——品味第一杯咖啡Java咖啡馆(4)——品味第一杯咖啡

2005-03-09 14:53 出处:PConline 作者:Gary Chan 责任编辑:xietaoming

  没错,当你把鼠标移动到一个Java类、变量或方法上,Eclipse将通过代码分析技术在源代码中萃取出相应的Java文档并且显示给你看,如果该Java元素有文档的话。
下面让我们为main方法编写Java文档来亲自体验一下。首先把光标移动到public class HelloWorldApp {之后并回车以便插入一空白行。然后,输入/**并且回车,你会发现Eclipse自动为你生成如一个Java文档块,并且自动识别出main方法有一个名为args的参数(很神奇吧?)。把该文档改写成这样:

/**
* 这是主函数,程序将从这里开始运行。
* @param args 命令行参数
*/

  然后你把鼠标移动到main上面,是不是得到明明白白的文档信息了?

  实际上,Java文档功能是贯穿于Java语言中的重要功能。但当你把光标移动到System.out.println("Hello World!")语句上,却得不到有用的含义以及参数的用法,该语句还是Java内置的API呢。怎么会这样子?

  聪明的你一定想到答案了——一定是Java API的Java文档没有配置好嘛。没错,J2SE SDK并不包含Java API的Java文档,需要单独下载。你可以从http://java.sun.com/j2se/1.4.2/download.html下载到J2SE 1.4.2的文档,如果你从国外下载不方便,还可以到http://garychan.3322.org的Java资源栏目下载,约32.80MB。下载以后请把压缩包中的doc目录解压缩到C:\j2sdk1.4.2_04\中。

  Eclipse默认使用JRE作为Java虚拟机。然而,使用J2SE SDK本身是更好的选择,因为你可以开启查看Java API文档的重要功能,这对于提高软件的开发效率以及深刻体验Eclipse,有着重要意义。方法如下:

  1.依次点击Eclipse菜单项中的Windows、Preferences。

  2.展开Java/Installed JRE,按下Add,按照图2所示填写参数(图2   完成后按下OK键)。

  3.在Installed JREs对话框中的J2SDK 1.4.2_04前面打上勾,按下“OK”关闭Preferences对话框。Eclipse会提示你需要重新编译一次,“OK”即可。

  好了,现在把光标移动到println上看看是不是和图3所示一样呢(图3)?

  怎么样,该方法的详细使用说明都有了吧?如果内容比较多,按下F2锁定之后便可以察看全部的信息。以后有什么API不明白,不用苦苦上网搜索了,Java API文档本身就是Java API的大百科,再配合Eclipse的自动显示功能,实在方便得不行。

  顺便说一句,Java还提供了从源代码中自动萃取Java文档,生成HTML文件以便单独阅读的机制,那就是J2SE SDK提供的javadoc工具。在Eclipse中,可以通过File菜单中的Export选项进行操作。

  Just do it

  试试把HelloWorldApp的Java文档改得更有调理,并且修改author属性成为你的名字。然后通过Eclipse内置的javadoc输出功能生成该项目的Java文档,感受一下Java文档代码并重的开发理念。

  Java文档是一门学问。除了上面用到的param和author标签,Java文档还支持许多特定的标签,可以直接内嵌HTML代码以便得到优美的输出,还可以通过doclets自行扩展javadoc的处理机制。完整的说明文档请参考C:\j2sdk1.4.2_04\docs\tooldocs\windows\javadoc.html。

键盘也能翻页,试试“← →”键

关注我们

最新资讯离线随时看 聊天吐槽赢奖品
閹靛婧€鐠佸潡妫�閸ョ偛鍩屾い鍫曞劥