day09 包机制及javadoc

包机制

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

• 包语法的语法格式为：

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

• 一般利用公司域名倒置作为包名；
• 为了能够使用某一个包的成员，我们需要在Java程序中明确导入该包。使用“import”语法可完成此功能

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

JavaDoc

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

• 参数信息

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

• 生成javadoc文档的方法

1. 命令行窗口执行命令：javadoc -encoding UTF-8 -charset UTF-8 XXXX.java
2. 在idea中生成：选择Tools中的generate javadoc，然后按下图操作

例：

package com.wangchuan.base;

/**
 * @author wangchuan
 * @version 1.0
 * @since 1.8
 */

public class Doc {

    String name;

    /**
     * @author wangchuan
     * @param name
     * @return
     * @throws Exception
     */
    public String test(String name) throws Exception{
        return name;

        //我是通过命令行生成：javadoc -encoding UTF-8 -charset UTF-8 Doc.java

        //作业：学会查找使用IDEA生成javadoc文档！ 面向百度编程！
    }
}