包機制和JAVADOC 生成文檔

包機制

• 爲了更好地組織語言 ，JAVA提供了包機制，用於區別類名的命名空間

• 包語句的語法格式爲：

  package pkg1[. pkg2[. pkg3...]];
  
  

• 一般利用公司域名倒置爲包名：com.baidu.www

• 爲了能夠使用一個包的成員，我們使用在java程序中明確導入該包，使用“import”語句可以完成此功能

  import package1[.package2..].(classname|*);
  

JAVADOC

• javadoc命令是用來生成自己的API文檔

參數信息

• @auther 作者名
• @version 版本還
• @since 指明需要最早使用的jdk版本號
• @param 參數名
• @return 返回值情況
• @throws 異常拋出情況

CMD生成javadoc

在源文件的根目錄cmd窗口下

javadoc -encoding UTF-8 -charset UTF-8 Doc.java
上面的 Doc.java 是文件名

idea生成javadoc

菜單 “Tools->Gerenate JavaDoc” 面版的 “Other command line arguments:” 欄裏輸入 “-encoding utf-8 -charset utf-8”.

舉例

package com.luan.base;


public class Doc {
    String name;
    public String test(String name) throws Exception{
    return name;
    }
    //命令生成javadoc
    //idea生成jacvadoc
}