栏目分类:
子分类:
返回
名师互学网用户登录
快速导航关闭
当前搜索
当前分类
子分类
实用工具
热门搜索
名师互学网 > IT > 软件开发 > 后端开发 > Java

JavaDoc学习笔记

Java 更新时间: 发布时间: IT归档 最新发布 模块sitemap 名妆网 法律咨询 聚返吧 英语巴士网 伯小乐 网商动力

JavaDoc学习笔记

JavaDoc学习笔记 java学习过程中的一些笔记 使用JavaDoc可以生成自己的Java项目的API文档。

在代码中输入“

然后可以在其中输入“@”加上参数信息,记录你的文件的相关参数信息,如作者、版本号等等:


然后打开文件所在位置:

然后在此路径下打开cmd命令行,快捷方式是在路径前加上cmd空格然后回车

(如果觉得字体等不合适代话,可以右键命令行窗口的边框,然后修改默认设置:


然后命令上执行javadoc:

javadoc -encoding UTF-8 -charset UTF-8 java0001.java

其中,-encoding和-charset两个参数是将编码和字符编码的格式都设置为utf-8,避免出现一些编码格式错误,最后的java0001.java是我的文件名。意思是把我们的java0001.java文件编译成一份java文档。

然后回车,会显示正在生成各种文件。

回到原目录下,可以看到生成了一堆文件。点开其中的index.html首页文件:


可以看到生成了和我们的java文件内容相对应的Java文档。我们这里文件里没写什么东西,所以看到都是空白。

以上即为javadoc的基本使用方法。

如果你是用IDEA写代码的话,也可以使用Tools里面的Generate JavaDoc来生成文档:

里面的各选项根据需求进行调整即可。

转载请注明:文章转载自 www.mshxw.com
本文地址:https://www.mshxw.com/it/397003.html
我们一直用心在做
关于我们 文章归档 网站地图 联系我们

版权所有 (c)2021-2022 MSHXW.COM

ICP备案号:晋ICP备2021003244-6号