Java菜鳥學習筆記(3)--Java API 文檔下載與文檔註釋的使用

爲何須要API文檔？

1.Java提供了大量的基礎類，再進行Java不可能把全部的類和方法記下來，由於遇到不肯定不懂的地方，能夠查看文檔。

2.學會查看文檔是一個程序員基本的素質。

使用流程

1.使用Oracle提供的Java在線API：

                                   http://docs.oracle.com/javase/7/docs/api/

2.使用本地化的API DOC：

   先去官方網站下載區：http://www.oracle.com/technetwork/java/javase/documentation/java-se-7-doc-download-435117.html

   而後將下載厚的Jdk-7u25-apidocs.zip解壓。 

   而後打開解壓文件的 index.html就能夠查看文檔了

爲何要文檔註釋？

1.在團隊合做中須要讓其餘成員看懂不一樣成員寫的類，就能夠製做API文檔對類，package等進行描述和說明。

使用Javadoc文檔註釋

1.註釋格式：

                          /**（內容） */

2.關鍵字列表

（在源碼在能夠註釋的關鍵字列表）

@author 做者名

@version 版本標識

@parameter 參數及其意義

@since 最先使用該方法/類/接口的JDK版本

@return 返回值

@throws 異常類及拋出條件

@deprecated 引發不推薦使用的警告

@see reference

@override 重寫

3.用法

                javadoc [選項] [軟件包名稱] [源文件] [@file]