Java包机制和文档注释

Java包机制和文档注释

Java包机制

• 类似于不同文件夹里同名文件机制。
• 语法格式：package pkg1[.pkg2[.pkg3…]]
• 一般利用公司域名倒置作为包名，如www.baidu.com为com.baidu.www
• 为了导入其他成员的包，使用import，并且必须写在自己的包下面。例如:import com.ilzy.blog.test.test1
• 虽然不同包之间可以使用同样的文件名，但尽量不要重复，否则导入将会报错。
• .*可以导入包内所有类。

JavaDoc

语法格式和参数信息：

    *@author  作者名
    *@version  版本号
    *@since  指明需要最早使用的jdk版本
    *@param   参数名
    *@return  返回值情况
    *@throws   异常抛出情况
   */


- 可以加在类里面或者方法里面。

```package com.ilzy.blog.operator;
/**
 * @author ilzy
 * @version 1.0
 * @since 1.8
 */
public class Test8 {
    String name;
    /**
     * @author ilzy
     * @param name
     * @return
     * @throws Exception
     */
    public String test(String name)throws  Exception{
        return name;
    }
}```


- 在终端使用命令生成JavaDoc：javadoc -encoding UTF-8 -charset UTF-8。中文使用UTF-8格式编码，别的字符也使用同样编码。