包机制和JavaDoc生成文档 2021-11-16

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

心️要努力吖

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

阅读量400

点赞数

分类专栏：笔记文章标签： java

本文链接：https://blog.csdn.net/m0_56661579/article/details/121329178

版权

笔记专栏收录该内容

61 篇文章 0 订阅

订阅专栏

本文介绍了Java编程中的包机制，强调了包名的一般规则，并展示了如何通过取消勾选'CompactMiddlePackages'来显示多级目录。还讲解了如何快速查看类和包，以及如何自动导入和重新生成导入包。此外，文章详细讨论了JavaDoc的用途，包括各种注解的使用，并给出了一个简单的JavaDoc注释示例。最后，提到了使用IDEA生成JAVADOC文档的方法和步骤。

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

Day13

包机制（本质：文件夹）

包名定义的规则：一般利用公司域名作为包名
如果是www.baidu.com 包的命名就是com.baidu.www

这个时候可能出现的状况：不会出现一级一级的目录
方法：右侧设置键里 Compact Middle Packages 取消勾线即可变为一层一层的目录
在这里插入图片描述
电脑快捷键截图：

将目录优化

随便打开一个类，就会出现package

若想要查看该单词的用法：按住Ctrl键，再按鼠标左键，即可查到

在这里插入图片描述

打开lang 包：按住Ctrl键，再按鼠标左键，即可查看

有的时候需要导入其他包进行使用
使用日期输入后直接回车，系统会自动导入一个包，如果不小心将这个导入包删了，按住Alt键，回车再回车，就会重新生成
注意：import（导入包）只能在package（定义包）下面，不能换顺序
在这里插入图片描述

//导入这个包下所有的类,用*    *是一个通配符
import com.kuang.*;

JavaDoc

在线API帮助文档
https://docs.oracle.com/javase/8/docs/api/

javadoc命令是用来生成自己的API文档的
参数信息

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

文档注释

package com.kuang.base;

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

注解和注释的区别(可以生成一个网页)

在这里插入图片描述
打开文件所在位置

在cmd中输入javadoc -encoding UTF-8 -charset UTF-8 Doc.java

此时查看文件夹会出现很多其他东西

打开Index.html

学会查找使用IDEA生产JAVADOC文档
https://blog.csdn.net/qq_48987257/article/details/117933633
可以在这个网页下尝试生成