包机制 JavaDoc

包机制

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

• 包语句的语法格式为：

  package pkg1[. pkg2[. pkg3…]]; com.zhao.www

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

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

JavaDoc

• javadoc命令是用来声称自己的API文档的
• 参数信息
  • @author 作者名
  • @version 版本号
  • @since 指明需要最早使用的jdk版本
  • @param 参数名
  • @return 返回值情况
  • @throws 异常抛出情况

idea内有生成Javadoc文档方法

ieda顶部菜单Tools—>Generate JavaDoc，在Output directory输入存放地址，在底部的Locale输入配置语言和编码机，zh_CN代表中文，-encoding UTF-8 -charset UTF-8。

package com.zhz.base;


/**
 * @author zhz
 * @version 1.0
 * since 1.8
 */
public class Doc {
    String name;

    /**
     * *@author zhz
     * @param name
     * @return
     * @throws Exception
     */

    public String test(String name) throws Exception{
        return name;

    }

}