Java學習07:包機制&JavaDOC生成文件
阿新 • • 發佈:2022-04-05
包機制
介紹
- 包機制類似於資料夾,但是不完全等於資料夾。
包語句的語法格式為:
package pkg1[. pkg2[. pkg3...]];
一般使用公司域名倒置作為包名。com.cnblogs.www
匯入包
為了能夠使用某一個包的成員,我們需要在Java程式中明確匯入該包。
使用"import"語句可完成此功能
例如,當你使用Date以後,會報錯,是因為沒有匯入java自帶的那個包
按住alt+enter可以自動排錯,這時你可以點選想要匯入的包,
上面就會寫出“import java.util.Date"
import java.util.Date; import com.baidu.www.*;//當你需要匯入包下所有的類,可以寫一個星號*
JavaDoc生成文件
- javadoc命令是用來生成自己的API文件的。
文件註釋
- 輸入/**按回車後會直接生成文件註釋,在類上面加或者在方法上面加是不一樣的(後者會自動生成一些東西。)
package com.nekodream.base; /** * @author NekoDream * @version 1.0 * @since 1.5 */ public class Doc { String name; /** * * @param name * @return * @throws Exception */ public String test(String name)throws Exception { return name; } }
引數名 | 是什麼 |
---|---|
@author | 作者名 |
@version | 版本號 |
@since | 指明需要使用的最早jdk版本 |
@param | 引數名 |
@return | 返回值情況 |
@throws | 異常丟擲情況 |
通過命令列(CMD)生成說明文件
- 進入CMD,在需要生成包的資料夾地址上輸入javadoc,再空格,輸入你想生成的類名。
- 為了防止亂碼,可以再javadoc後面輸入 -encoding UTF-8 - charset UTF-8
舉個例子:
D:\java code\com\nekodream\base>javadoc -encoding UTF-8 -charset UTF-8 Doc.java
通過IDEA生成javadoc文件
很簡單。
- 工具-生成javadoc。