一、单行注释
用//text 表示单行注释,例子如下
1 public static void main(String []args){
2 //打印输出到控制台
3 System.out.println("FirstJava");
4 System.out.print("FirstJava
");
5 //System.out.println("FirstJa va");
6 }
二、多行注释
用/* text */表示多行注释,例子如下
/*
public String toString(String content){
return content;
}
*/
三、文档注释
用/**
* text
*/ 表示文档注释,举例
1 /**
2 *Sescription:这是第一个Java程序
3 *Author:泊而至远
4 *Create Date:2016-2-29
5 *Modified Date:2016-3-1
6 *Modified By:泊而至远
7 */
8 public class First{
9 /**
10 *Description:程序入口点
11 *参数:字符串数组
12 */
13 public static void main(String []args){
14 //打印输出到控制台
15 System.out.println("FirstJava");
16 System.out.print("FirstJava
");
17 //System.out.println("FirstJa va");
18 }
19
20 /**
21 *Description:显示输出个人信息
22 *@return String:姓名
23 *@param content:个人资料
24 */
25 public String toString(String content){
26 return content;
27 }
28 }
该注释可以生成API文档,使用命令:javadoc -d 生成目标路径 源文件
例如Javadoc -d doc Frist.java 这句话表示将Frist.java源文件的注释生成在D:JavaStudy 下的doc文件夹中
文件夹如下图
打开doc下的index.html可以看到api文档
但注释未换行,若要换行只需在注释后加上<br />标签,重新生成后刷新页面,代码举例如下
1 /**
2 *Sescription:这是第一个Java程序<br/>
3 *Author:泊而至远<br/>
4 *Create Date:2016-2-29<br/>
5 *Modified Date:2016-3-1<br/>
6 *Modified By:泊而至远<br/>
7 */
8 public class First{
9 /**
10 *Description:程序入口点<br/>
11 *参数:字符串数组<br/>
12 */
13 public static void main(String []args){
14 //打印输出到控制台
15 System.out.println("FirstJava");
16 System.out.print("FirstJava
");
17 //System.out.println("FirstJa va");
18 }
19
20 /**
21 *Description:显示输出个人信息<br/>
22 *@return String:姓名<br/>
23 *@param content:个人资料<br/>
24 */
25 public String toString(String content){
26 return content;
27 }
28 }
页面刷新之后就可看到换行效果