Java基础06：包机制和javadoc

包机制

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

• 包语句的语法格式为

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

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

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

  使用import语句

  import pkg1[ .pkg2...] . (classname|*);

JavaDoc

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

• 参数信息

  @author 作者名

  @version 版本号

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

  @param 参数名

  @return 返回值情况

  @throws 异常抛出情况

package com.siri.base;

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

    //我是通过命令行 javadoc 参数 java文件名
    //            -encoding UTF-8 -charset UTF-8

    //学会查找和使用IDEA生成javadoc文档   面向百度编程

    //基础部分的一切知识后面几乎每天都会用
}

用命令行生成Javadoc文档

cmd 目录

javadoc -encoding UTF-8 -charset UTF-8 Doc.java

会生成这样一个文件夹，找index文件打开