包机制和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
}