Java基礎_註釋與生成API

1、Java 中註釋有三種類型：單行註釋、多行註釋、文檔註釋

/**
  這是我的第一個文件：文檔註解
  @author lxp
  @version 1.1.1
 */
public class HelloWorld{
	
	/*
	  1、多行註解
	  2、多行註解
	 */
	public static void main(String[] args){  
		//單行註解
		System.out.println("Hello World");  
	}  
}

被註釋的代碼塊在程序運行時是不會被執行。

2、通過 javadoc 命令從文檔註釋中提取內容，生成程序的 API 幫助文檔。

打開首頁，查看下生成的 API 文檔

 

PS：使用文檔註釋時還可以使用 javadoc 標記，生成更詳細的文檔信息：

       @author 標明開發該類模塊的作者

       @version 標明該類模塊的版本

       @see 參考轉向，也就是相關主題

       @param 對方法中某參數的說明

       @return 對方法返回值的說明

       @exception 對方法可能拋出的異常進行說明