Java基础04（包机制和JavaDoc文档生成）

6.包机制

• 为了更好地组织类，Java提供了包机制，用于区别类名的命名空间。

• 一般利用公司域名导致作为包名

  如：com.baidu.www

• 为了能够使用某一个包的成员，我们需要在Java程序中明确导入改包。使用“import”语句可完成此功能。

7.JavaDoc文档生成

• javadoc命令是用来生成自己API文档的

• 参数信息

  1. @author 作者名

  2. @version 版本号

  3. @since 指明需要最早使用的jdk版本

  4. @parm 参数名

  5. @return 返回值情况

  6. @throws 异常抛出情况

/**
 * @author yhj
 * @version 1.0
 * @since 1.8
 */
public class Doc {

    String name;

    /**
     *
     * @param name
     * @return
     * @throws Exception
     */
    public  String test(String name) throws  Exception{
         return name;
    }

}

生成java文档的两种方法：

1. cmd，运行 javadoc -encoding UTF-8 charset UTF-8 Doc.java

   

2. 使用IDEA生成文档

​ Tools-Generate JavaDoc
注：此种方法路径中不能出现任何中文