六、包机制与JavaDoc

最新推荐文章于 2024-10-16 10:13:45 发布

&小小白&

最新推荐文章于 2024-10-16 10:13:45 发布

阅读量217

点赞数 6

分类专栏： Java 文章标签：冯诺依曼结构 java 数据类型

本文链接：https://blog.csdn.net/qq_52916408/article/details/118556094

版权

Java 专栏收录该内容

6 篇文章 0 订阅

订阅专栏

本文介绍了Java中的包机制，用于区分类的命名空间，通常使用公司域名倒置作为包名。同时讲解了如何使用import导入包。此外，详细阐述了JavaDoc的基本概念和使用，包括@author、@version等标签，并通过实例展示了如何生成API文档。最后，提供了生成JavaDoc的步骤，包括编写代码、在命令行运行javadoc命令以及查看生成的index.html。

摘要由CSDN通过智能技术生成

一、包机制

为了更好的组织类，Java提供了包机制，用于区别类名的命名空间。
包语句的语句格式为：

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

一般使用公司域名倒置作为包名：例如（com.baidu.www）

为了能够使用某一个包的成员，我们需要在Java程序中明确导入该包。使用"import"语句可完成此功能。

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

二、JavaDoc

2.1、基本概念

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

参数信息

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

2.2、实现

2.2.1、先写好代码

package JavaDoc;

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

}