1. 程式人生 > 其它 >Java基礎 包機制和註釋文件

Java基礎 包機制和註釋文件

Java基礎

一、包機制

為了便於類包的管理和命名衝突建立的資料夾

1.建包 Package

命名規範:

package package1.package2.package3.(類名)……

注意事項:

  1. 建立公司的包時,要嚴格遵守域名倒置 例如:com.baidu.www

  2. package語句要寫在最頂端


2.導包 import

命名規範:

import java.lang.date.(類名)……

注意事項:

import語句要寫在package語句之下,類的外面


二、註釋文件

Java支援單行註釋、多行註釋和註釋文件

註釋文件是用於在程式內生成關於程式的資訊,使程式設計師更方便的記錄程式的資訊

1.註釋文件的基本引數

寫在類的外部

/**

  • // 註釋文件

  • @author Wavesboker //作者名

  • @version //版本號

  • @since //開發用的Java版本

  • @param //引數名

  • @return //返回值

  • @throws //異常丟擲情況 */


寫在方法內

public class Demo10 { String name;

/** *

  • @param name

  • @return

  • @throws Exception //丟擲異常 */

public String Test(String name) throws Exception{ return name;

}


2.使用命令列生成doc檔案

在資料夾內開啟cmd

命令列內使用javadoc指令生成API文件

-encoding UTF-8 將編碼格式輸出為UTF - 8 以免因中文產生亂碼

-charset UTF -8 將字符集編碼格式也改成UTF-8

Demo1.java 選擇生成doc資訊的檔案


3.使用IDEA軟體生成Doc文件

選擇Tools > Generate Javadoc

按步驟設定 > 點選OK