练习(11)找出HelloDate.java的第二个版本,也就是那个简单注释文档的示例。对该文件执行javadoc,然后通过web浏览器观看运行结果。
HelloDate.java的第二个版本就是P35面有注释那个版本
代码:
import java.util.Date;
/**
* Created by lenovo on 2016/7/30.
* The first Thinking in java example program.
* Displays a string and today's date.
* @author nikerxu
* @version 1.0
*/
public class test2_11 {
/**
* Entry point to class & application.
* @param args array of string arguments.
* @throws exceptions No exception thrown
*/
public static void main(String[] args){
System.out.println("Hello,it's: ");
System.out.println(new Date());
}
}
生成javadoc的方法,在eclipse里找project,itellij里找tools这两个菜单目录下会有一个generate javadoc的选项,点击即可生成javadoc
生成的文件目录如下
在thinking in Java里面(这个是工程名,找你项目所在的工程名即可),找到test2_11也就是类名,打开就是
练习(13)与(12)做法相同,不再重复。
这里简单介绍一下注释的几种类型。
首先注释方式有三种:
一种是先打/**,然后按enter键就会出现这样的:
/**
* 注释内容
*/
另一种与上一种方式类似,先打/*,按enter键后:
/*
注释内容
*/
这两种有什么区别呢?如果你使用编译器就会发现,第一种与第二种颜色是不一样的,在第一种注释里打@,会出来类似代码提示的提示信息,而第二种,则没有。不过两种注释方式注释的内容都会忽略,所以大同小异,只不过第一种方便一点。
还有一种方式是按Ctrl+/ ,会出现//并将光标所在的行注释掉,这种方法称为单行注释,是最方便的。
基本的一些标签:
@author 用于对类的说明 标明开发该类模块的作者
@version 用于对类的说明 标明该类模块的版本
@see 用于对类、属性、方法的说明 参考转向,也就是相关主题
@param 用于对方法的说明 对方法中某参数的说明
@return 用于对方法的说明 对方法返回值的说明
@exception 用于对方法的说明 对方法可能抛出的异常进行说明
更具体内容请看书本或Java官方文档的介绍。
以上