單行註釋、多行註釋與文檔註釋

單行註釋：// 註釋內容

多行註釋：/* 註釋內容*/

文檔註釋：/** 註釋內容 */ （它是java語言特有的註釋，其中的註釋內容能夠被JDK提供的工具 javadoc 所解析，生成一套可以以網頁形式體現程序的說明文檔）

區別：多行註釋不能夠生成開發者文檔，而文檔註釋能夠生成開發者文檔（文檔分爲使用者文檔和開發者文檔）。

注意規範點：

一、三種註釋均可以出如今程序的任何地方，可是通常要有個規範的地方，不推介任意找位置。

二、單行註釋通常寫在語句的後面。

三、多行註釋和文檔註釋通常寫在語句的上面，文檔註釋只能出如今類、屬性、方法的上面，不然提取不到。

四、多行註釋中能夠嵌套單行註釋，多行註釋中不能嵌套多行註釋。

文檔註釋的使用（若是一個類想要使用javadoc工具生成開發者文檔，那麼這個類必須使用public修飾）：

在已經成功安裝jdk並已經配置好path環境變量的前提下

一、使用dos命令

使用 javadoc 開發工具生成，在命令行下輸入javadoc會有一些javadoc使用說明能夠看到。咱們使用javadoc -d命令，使用格式：javadoc -d 存放路徑 java源文件

二、eclipse

使用eclipse就沒有這麼些問題了，直接建立java類，而後Project-->Generate Javadoc，點擊Generate Javadoc後，進入彈出的界面，選擇javadoc.exe命令的位置，選擇要生成Javadoc的包，或者包下的類，以及生成的Javadoc文檔所存的路徑，默認生成到當前工程目錄下。以後會生成Javadoc文件:在生成文檔的目錄下會有一堆文件，找到index.html文件，打開查看具體的內容就ok。