Java學習 （二）、注釋，java學習注釋
一、單行注釋
用//text 表示單行注釋，例子如下
![]()
1 public static void main(String []args){
2 //打印輸出到控制台
3 System.out.println("FirstJava");
4 System.out.print("FirstJava\n");
5 //System.out.println("FirstJa\tva");
6 }
View Code
二、多行注釋
用/* text */表示多行注釋，例子如下
![]()
/*
public String toString(String content){
return content;
}
*/
View Code
三、文檔注釋
用/**
* 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\n");
17 //System.out.println("FirstJa\tva");
18 }
19
20 /**
21 *Description：顯示輸出個人信息
22 *@return String：姓名
23 *@param content：個人資料
24 */
25 public String toString(String content){
26 return content;
27 }
28 }
View Code
該注釋可以生成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\n");
17 //System.out.println("FirstJa\tva");
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 }
View Code
頁面刷新之後就可看到換行效果
