13 -Java基初 包机制 JavaDoc

包机制

• 为了更好的组织类,Java提供了包机制,用于区别类名的命名空间
• 包语句的语法格式为:

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

• 一般利用公司域名倒置作为包名;
• 为了能够使用某一个包的成员,我们需要在Java程序中明确导入该包.使用"import"语句可以完成此功能

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

• 包的本质就是一个文件夹
• • 号是一个通配符 导入包下所有的类

JavaDoc

什么是javadoc

• jdk帮助文档
• javadoc命令是用来生成自己API文档的
• javadoc是一种技术,可以帮助我们把注释信息生成一个帮助文档
• 参数信息
  • @author 作者名
  • @version 版本号
  • @since 指明需要最早使用的jdk版本
  • @param 参数名
  • @return 返回值情况
  • @throws 异常抛出情况

package JavaDoc;

/**类注释
 * @author Zhizun
 * @version 1.0
 * @since 1.8
 */
public class JavaDoc {
    String name;

    /**方法注释
     * @author Zhizun
     * @param name
     * @return
     * @throws Exception
     */

    public String test(String name)throws Exception{
        return name;
    }
    //命令行  javadoc -encoding UTF-8 -charset UTF-8
}

使用命令行生成javadoc

命令行 javadoc -encoding UTF-8 -charset UTF-8

使用IDEA生成javadoc

扩展: 阿里巴巴开发手册(百度)