IT数码 购物 网址 头条 软件 日历 阅读 图书馆
TxT小说阅读器
↓语音阅读,小说下载,古典文学↓
图片批量下载器
↓批量下载图片,美女图库↓
图片自动播放器
↓图片自动播放器↓
一键清除垃圾
↓轻轻一点,清除系统垃圾↓
开发: C++知识库 Java知识库 JavaScript Python PHP知识库 人工智能 区块链 大数据 移动开发 嵌入式 开发工具 数据结构与算法 开发测试 游戏开发 网络协议 系统运维
教程: HTML教程 CSS教程 JavaScript教程 Go语言教程 JQuery教程 VUE教程 VUE3教程 Bootstrap教程 SQL数据库教程 C语言教程 C++教程 Java教程 Python教程 Python3教程 C#教程
数码: 电脑 笔记本 显卡 显示器 固态硬盘 硬盘 耳机 手机 iphone vivo oppo 小米 华为 单反 装机 图拉丁
 
   -> 开发工具 -> JavaDoc生成文档(文档注释前面说注释的时候留过概念) -> 正文阅读

[开发工具]JavaDoc生成文档(文档注释前面说注释的时候留过概念)

JavaDoc生成文档(文档注释)

  • 参数信息:

  • @author 作者名

  • @version 版本号

  • @since 指明需要最早使用的jdk版本

  • @param 参数名

  • @return 返回值情况

  • @throws 异常抛出情况

可以在网上搜:jdk帮助文档

?

?

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

IDEA里就可以写一个自己的API文档如下

?

?

除了这些,我们还可以做更多操作,比如:

抛出异常

在刚刚原来代码的基础下

?在箭头处输入:throws Exception,如下图:

?然后再在String name;的下一行输入/**并回车得到如下

其中可以修改的内容,都在本文的最上面的参数信息里。

注意:

文档注释加在类的上面就是类的注释,加在方法的上面,就是方法的注释

文档注释加起来和注释的区别

?我们在文件夹中打开我们刚刚写的代码,

?然后会得到一堆乱七八糟

我们为了整洁要在javadoc后面输入一些代码,来保证一些报错可以省略,可以使中文显示的更加正常

javadoc -encoding UTF-8 -charset UFT-8 Doc.java

?然后发现他有警告没有说明,可以不管,有警告但是都运行了下来,生成的东西都在刚刚打开的文件夹里,这里由于演示生成了两次,文件夹会比较多

?

?这就是java生成的文档,和我们刚刚看到的java官网的jdk帮助文档差不多

?但是注意,我们生成的里面很干净

这个Doc可以点进去

?

?最终这个文档生成了,这就是用命令行生成javadoc文档

在看下一篇前我们要学会:查找使用IDEA生成javaDoc文档 ,如果不会

我们一定要学会:面向百度编程

就是有问题先百度,有困难问老师同学,这就是团体的力量,一群志同道合的人一起学习。

  开发工具 最新文章
Postman接口测试之Mock快速入门
ASCII码空格替换查表_最全ASCII码对照表0-2
如何使用 ssh 建立 socks 代理
Typora配合PicGo阿里云图床配置
SoapUI、Jmeter、Postman三种接口测试工具的
github用相对路径显示图片_GitHub 中 readm
Windows编译g2o及其g2o viewer
解决jupyter notebook无法连接/ jupyter连接
Git恢复到之前版本
VScode常用快捷键
上一篇文章           查看所有文章
加:2022-02-07 13:55:13  更:2022-02-07 13:57:51 
 
开发: C++知识库 Java知识库 JavaScript Python PHP知识库 人工智能 区块链 大数据 移动开发 嵌入式 开发工具 数据结构与算法 开发测试 游戏开发 网络协议 系统运维
教程: HTML教程 CSS教程 JavaScript教程 Go语言教程 JQuery教程 VUE教程 VUE3教程 Bootstrap教程 SQL数据库教程 C语言教程 C++教程 Java教程 Python教程 Python3教程 C#教程
数码: 电脑 笔记本 显卡 显示器 固态硬盘 硬盘 耳机 手机 iphone vivo oppo 小米 华为 单反 装机 图拉丁

360图书馆 购物 三丰科技 阅读网 日历 万年历 2024年11日历 -2024/11/15 10:33:31-

图片自动播放器
↓图片自动播放器↓
TxT小说阅读器
↓语音阅读,小说下载,古典文学↓
一键清除垃圾
↓轻轻一点,清除系统垃圾↓
图片批量下载器
↓批量下载图片,美女图库↓
  网站联系: qq:121756557 email:121756557@qq.com  IT数码