JavaSE 基础（四）包机制和JavaDoc

本文链接：https://blog.youkuaiyun.com/qq_42651415/article/details/114385068

本文详细介绍了Java中的包机制及其使用方法，包括如何定义和导入包，并遵循命名规范。此外，还深入探讨了JavaDoc的使用技巧，如如何为代码添加注释以生成API文档。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

1. 包机制

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

包语句的语法格式如下：

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

package com.baidu.www; //例子

通常情况下使用公司域名倒置作为包名。以www.baidu.com为例：

使用某个包的成员，需要在Java程序中明确导入改包。导入包的语句如下：

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

import java.util.Date; //导入Java中的世间类
import java.util.*; //导入util包内所有类

【注意】
- package语句要在import语句之上。
- 包内不允许出现相同类名。

2. JavaDoc

JavaDoc命令是用来生成自己的API文档的。

参数信息

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

@throws 异常抛出情况

package com.baidu.www;

/**
 * @author  Why
 * @version 1.0
 * @since   1.8
 */
public class Hello {

    String txt = "Hello World";

    /**
     * @author Why
     * @param  txt
     * @return String
     * @throws Exception
     */
    public String test(String txt) throws Exception{
        return txt;
    }
}

执行javadoc命令生成文档
- 打开当前类所在目录（我用的软件是IDEA2018）。
- 在此目录打开命令行
- 运行命令javadoc -encoding UTF-8 -charset UTF-8 文件名.java
  - javadoc：生成API的编译命令。
  - -encoding UTF-8：设置编码格式，以UTF-8格式进行编译。
  - -charset UTF-8：设置字符级编码，将字符以UTF-8格式进行编译，防止中文乱码。
- 查看目录下生成的index.html文件
- 点击类名（Hello），查看该类的详情。
使用IDEA生成javadoc文档^[1]
JavaSE官方API帮助文档