009Java学习--包机制、JavaDoc

包机制

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

• 包语句的语法格式为：

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

• 一般利用公司域名倒置作为包名；

  （阿里巴巴java开发手册） www.baidu.com com.baidu.www

• 为了能够使用某一个包的成员，我们需要在Java程序中明确导入该包。

• 使用"import"语句可完成此功能

  import package1[.package2...].(classname|*);
  import com.baidu.*;(*:通配符)
  

JavaDoc生成文档

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

• 参数信息

  • @author 作者名

  • @version 版本号

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

  • @param 参数名

  • @return 返回值情况

  • @throws 异常抛出情况

package operator;

/**
 * @author zhang
 * @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;
    }
}

链接: https://www.runoob.com/java/java-documentation.html.