包机制和JavaDoc命令

包机制

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

• 包语句的语法格式为：

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

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

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

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

• .* 代表通配符 它会导入包下所有的类

JavaDoc

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

• 参数信息

  • @author 作者名

  • @version 版本号

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

  • @param 参数名

  • @return 返回值情况

  • @throws 异常抛出情况

package com.shuai.base;

/**
 * @author shuai
 * @version 1.0
 * @since 1.8
 */

public class Demo {

    String name;

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

    }
}

用JavaDoc命令生成API文档

另一种方法 用IDEA生成API文档

连接：https://blog.csdn.net/qq_42658739/article/details/102531538