Java学习笔记---javadoc

柯仔*

于 2020-09-13 14:37:31 发布

阅读量120

点赞数

分类专栏： Java学习笔记

本文链接：https://blog.youkuaiyun.com/qq_45498200/article/details/108562016

版权

7 篇文章

订阅专栏

本文介绍javadoc工具，一种从源代码注释自动生成API文档的方法。通过特定标签注释代码，使用命令行工具即可生成配套的开发文档，便于理解和维护。

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

什么是javadoc
javadoc是从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说，只要在编写程序时以一套特定的标签作注释，在程序编写完成后，通过Javadoc就可以同时形成程序的开发文档了。

使用命令行生成javadoc
使用cmd进入包所在的位置，方法有很多，这里选择打开包所在文件夹，编辑路径，前面加上cmd+空格，然后回车

进入cmd后，输入

javadoc -encoding UTF-8 -charset UTF-8 "文件名".java//文件名写你要生成的那个java文件
//-encoding UTF-8 -charset UTF-8是用来防止乱码的，可以不加

之后文件夹里会多出很多文件，打开index.html
在这里插入图片描述
生成成功