Java包机制以及JavaDoc

包机制

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

• 语法(一般利用公司域名倒置作为包名 例:com.baidu.www):

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

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

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

JavaDoc

• 作用:JavaDoc命令是用来生成自己的API文档的

• 参数信息

  1. @author作者名
  2. @version版本号
  3. @since指明需要最早使用的jdk版本
  4. @param参数名
  5. @return返回值情况
  6. @throws异常抛出情况

• 使用cmd生成JavaDoc命令:javadoc 参数 java文件(Doc.java)

  例:javadoc -encoding UTF-8 -charset UTF-8 类名.java

• 使用idea生成JavaDoc

  网址:https://blog.csdn.net/weixin_42140580/article/details/89635775

  ​ https://blog.csdn.net/weixin_42140580/article/details/89635775

/**
 * @author  qll
 * @version  1.0
 * @since  1.8
 */
public class Doc {
    String name;
    /**
     * @author  qll
     * @param name
     * @return
     * @throws Exception
     */
    public String test(String name) throws  Exception{
        return "";
    }
}