包机制和javadoc

本文介绍了Java的包机制,用以解释如何通过包来组织和区分类名空间,并给出了包名的一般格式。此外,文章详细阐述了Javadoc的作用,它是用于生成API文档的工具,介绍了其主要参数如@author、@version等,并提供了通过命令行和IntelliJ IDEA生成API文档的方法。
摘要由CSDN通过智能技术生成

包机制和Javadoc

什么是包机制

包机制:为了更好地组织分类,Java提供了包机制,用于区别类名的空间

通俗地理解就是,一个文件夹下有两个相同文件名的文件,不更改文件名,再新建两个文件夹,分别存入相同文件名的文件

格式

一般利用公司域名倒置作为包名:

eg: www.baidu.com(域名)

​ com.baidu.www(包名)

为了使用包里的类,可以用 import进行导入

*表示通配符,可以导入包下所有的类!!!!


javadoc

什么是javadoc

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


参数信息:

  1. @author 作者名
  2. @version 版本号
  3. @since jdk版本
  4. param 参数
  5. return 返回值情况
  6. throws 异常抛出情况

如何生成API文档

通过命令行生成

  1. 找到文件地址
  2. 通过导航栏打开cmd窗口
  3. 输入javadoc -encoding UTF-8 -charset UTF-8 Doc.java

-encoding UTF-8 -charset UTF-8 //这一段代码是为了让中文被识别

通过IDEA生成API文档

  1. 点击工具

在这里插入图片描述

  1. 点击生成Javadoc

在这里插入图片描述

  1. 选择生成javadoc的范围

在这里插入图片描述

  1. 选择输出文档

在这里插入图片描述

5.填入其他命令行参数
在这里插入图片描述

  1. 点击OK设置成功
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值
>