如何理解Java中的包机制,如何有效使用JavaDoc生成文档

createh55个月前 (02-07)技术教程35

包机制

一般用公司域名倒置作为包名:如百度网址www.baidu.com,包命名为com.baidu.www(com.yang)

包必须在类的最上面,导入包使用语句import package 包名.(是通配符代表包名下所有内容)

搜索:百度搜阿里巴巴开发手册学习Java基础

JavaDoc

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

jdk帮助文档(浏览器搜索)

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

选择类右键选Show in explorer可进入类存储地址,在类地址前进入cmd,并输入javadoc -encoding UTF-8 -charset UTF-8 类名.java,执行后会在类存储地址生成index.html文件,点开之后是我们自己写的类的帮助文档说明

idea生成Javadoc文档

  1. 首先新建一个文件夹,用来专门存放Javadoc文档
  2. 打开idea选择要生成文档的代码
  3. 选择之后就看idea的顶部有一个Tools的菜单,选择Generate JavaDoc这个选项
  4. 然后会弹出一个界面,然后在Output directory 输入框后面的按钮点击进去选择刚才创建的文件夹
  5. 然后在下面的locale框中输入zh_CN,这个代表的就是中文,输完之后在locale下面的框中输入-encoding utf-8 -charset utf-8
  6. 最后点击ok,等待文件生成完毕之后,执行后会在JavaDoc文件夹生成index.html文件,点开之后是我们自己写的类的帮助文档说明

相关文章

Java实现文件上传和下载的方法详解

Java实现文件上传和下载的方法详解,Java实现文件上传和下载解决方案,Java实现文件上传和下载思路,Java实现文件上传和下载源码,Java实现文件上传和下载实例,Java实现文件分块上传和下载...

Java文件操作和IO_java实现文件操作

1.认识文件我们先来认识狭义上的文件(file)。针对硬盘这种持久化存储的I/O设备,当我们想要进行数据保存时, 往往不是保存成一个整体,而是独立成一个个的单位进行保存,这个独立的单位就被抽象成文件的...

Java堆栈文件生成和分析_java 堆栈

生成:jmap -dump:live,format=b,file=c:\heap.hprof 分析: jvisualvmHeapDump敏感信息提取工具 https://github.com/whwl...

SpringBoot实现大文件上传/下载(分片、断点续传)

SpringBoot实现大文件上传/下载(分片、断点续传),SpringBoot实现大文件上传/下载解决方案,SpringBoot实现大文件上传/下载思路,SpringBoot实现大文件上传/下载实例...

2025年Java开发者必读:编写文档的9种姿势

在2025年,Java代码的文档化对于保持项目的可维护性和减少开发团队之间的摩擦至关重要。随着代码库复杂性的增加,文档化确保了知识的共享、新成员的快速入职以及错误的减少。为什么Java代码文档化重要没...

java+上传整个文件夹的所有文件_java文件上传方式

java+上传整个文件夹的所有文件,java上传整个文件夹,java上传文件夹,java上传文件夹解决方案,java上传文件夹思路,java上传文件夹实例,java上传大文件,java分片上传大文件,...