【Java】命令行生成JavaDoc文档

最新推荐文章于 2024-01-12 23:03:10 发布
最新推荐文章于 2024-01-12 23:03:10 发布
阅读量2.8k 收藏 9
点赞数 5
分类专栏： Java 文章标签： java javadoc
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_43896318/article/details/104548051
版权

编写简单的文档注释

安利 → JavaDoc文档注释详解

/**
  * @author BlankSpace
  * @version 1.0
  */
public class JavaDocTest {
    /**
     * Default method to be run to print 'Hello World'
     * <p>Hello world</p>
     * @param args command line arguments
     */
    public static void main(String[] args) {
        System.out.println("Hello World");
    }
}

开辟一个新的文件夹

在这里插入图片描述

跳转到指定区域并生成文档

  1. JavaDocTest.java文件放到D:\JavaDocTest路径下。
  2. cmd输入D: ，从C盘切到D盘。
  3. 输入命令cd D:\JavaDocTest，跳转到指定路径下。
  4. 输入命令javadoc JavaDocTest.java，生成文档注释（无须提前编译好）。

在这里插入图片描述

发现生成的一系列文件

还挺丰富orz
在这里插入图片描述

-html5

在Java8→Java9的时候，加上-html5会表示使用HTML5的规范，但现在我用的Java11，我总觉得是默认了HTML5规范……
我这是写的还算规范，你要是写的不合规范的话，javadoc命令执行的时候会报警告或者报错。
在这里插入图片描述

查看文档内容

在这里插入图片描述
在这里插入图片描述

查看网页源码

<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="zh">
<head>
<!-- Generated by javadoc (11.0.3) on Thu Feb 27 23:41:28 CST 2020 -->
<title>JavaDocTest</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2020-02-27">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="script.js"></script>
<script type="text/javascript" src="jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="jquery/jquery-3.3.1.js"></script>
<script type="text/javascript" src="jquery/jquery-migrate-3.0.1.js"></script>
<script type="text/javascript" src="jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
    try {
        if (location.href.indexOf('is-external=true') == -1) {
            parent.document.title="JavaDocTest";
        }
    }
    catch(err) {
    }
//-->
var data = {"i0":9};
var tabs = {65535:["t0","\u6240\u6709\u65B9\u6CD5"],1:["t1","\u9759\u6001\u65B9\u6CD5"],8:["t4","\u5177\u4F53\u65B9\u6CD5"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "./";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>您的浏览器已禁用 JavaScript。</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!--   -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="跳过导航链接">跳过导航链接</a></div>
<a id="navbar.top.firstrow">
<!--   -->
</a>
<ul class="navList" title="导航">
<li><a href="package-summary.html">程序包</a></li>
<li class="navBarCell1Rev">类</li>
<li><a href="package-tree.html">树</a></li>
<li><a href="deprecated-list.html">已过时</a></li>
<li><a href="index-all.html">索引</a></li>
<li><a href="help-doc.html">帮助</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="allclasses.html">所有类</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
<noscript>
<div>您的浏览器已禁用 JavaScript。</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>概要:&nbsp;</li>
<li>嵌套&nbsp;|&nbsp;</li>
<li>字段&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">构造器</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">方法</a></li>
</ul>
<ul class="subNavList">
<li>详细资料:&nbsp;</li>
<li>字段&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">构造器</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">方法</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!--   -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<h2 title="类 JavaDocTest" class="title">类 JavaDocTest</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>JavaDocTest</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<pre>public class <span class="typeNameLabel">JavaDocTest</span>
extends java.lang.Object</pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!--   -->
</a>
<h3>构造器概要</h3>
<table class="memberSummary">
<caption><span>构造器</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">构造器</th>
<th class="colLast" scope="col">说明</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">JavaDocTest</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!--   -->
</a>
<h3>方法概要</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>所有方法</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">静态方法</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">具体方法</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">修饰符和类型</th>
<th class="colSecond" scope="col">方法</th>
<th class="colLast" scope="col">说明</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#main(java.lang.String%5B%5D)">main</a></span>&#8203;(java.lang.String[]&nbsp;args)</code></th>
<td class="colLast">
<div class="block">Default method to be run to print 'Hello World'</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!--   -->
</a>
<h3>从类继承的方法&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!--   -->
</a>
<h3>构造器详细资料</h3>
<a id="&lt;init&gt;()">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>JavaDocTest</h4>
<pre>public&nbsp;JavaDocTest()</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!--   -->
</a>
<h3>方法详细资料</h3>
<a id="main(java.lang.String[])">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>main</h4>
<pre class="methodSignature">public static&nbsp;void&nbsp;main&#8203;(java.lang.String[]&nbsp;args)</pre>
<div class="block">Default method to be run to print 'Hello World'
 <p>Hello world</p></div>
<dl>
<dt><span class="paramLabel">参数:</span></dt>
<dd><code>args</code> - command line arguments</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!--   -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="跳过导航链接">跳过导航链接</a></div>
<a id="navbar.bottom.firstrow">
<!--   -->
</a>
<ul class="navList" title="导航">
<li><a href="package-summary.html">程序包</a></li>
<li class="navBarCell1Rev">类</li>
<li><a href="package-tree.html">树</a></li>
<li><a href="deprecated-list.html">已过时</a></li>
<li><a href="index-all.html">索引</a></li>
<li><a href="help-doc.html">帮助</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="allclasses.html">所有类</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
<noscript>
<div>您的浏览器已禁用 JavaScript。</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>概要:&nbsp;</li>
<li>嵌套&nbsp;|&nbsp;</li>
<li>字段&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">构造器</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">方法</a></li>
</ul>
<ul class="subNavList">
<li>详细资料:&nbsp;</li>
<li>字段&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">构造器</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">方法</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
</footer>
</body>
</html>

总结

虽然我们使用javadoc命令完成了整个的文档生成，但我们至少亲手操作了一次IDE帮我们省略的工作，虽不复杂，但很棒的不是吗？

我们不能只会使用IDE这种开发工具，越是强大的IDE，往往越是隐去了更多我们的基本操作，对于掌握知识未必是好事。

星拱北辰
关注
  • 5
    点赞
  • 踩
  • 9
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
专栏目录
Java API文档.docx
06-25
Java API文档是Java编程语言的一部分，它是一组文档，提供了Java编程语言的标准类、接口、方法和属性的说明和示例。Java API文档通常包含在Java开发工具包(JDK)中，并可以通过Java编译器和Java虚拟机(JVM)使用。 Java API文档通常是通过Java开发工具包(JDK)中的文档生成器自动生成的。在JDK中，有一个命令行工具javadoc，可以通过指定要包含的类、接口和方法等参数来生成Java API文档。生成的Java API文档可以保存为HTML文件，并可以在Web浏览器中查看和浏览。在许多集成开发环境(IDE)中，例如Eclipse、NetBeans和IntelliJ IDEA等，都提供了内置的Java API文档浏览器，可以直接查看和搜索Java API文档。
redis中文api
lcxfeng的专栏
11-22 105
  &lt;!-- NewPage --&gt;   &lt;!-- Generated by javadoc (version 1.7.0_51) on Tue Nov 21 14:25:55 CST 2017 --&gt; JedisUtils &lt;script type="text/javascript"&gt;// &lt;![CDATA[ if (location.hr...
Java加密技术
beiyouqiang的专栏
02-23 6972
转自：http://www.cnblogs.com/duanxz/archive/2012/12/24/2830736.html 如基本的单向加密算法：  BASE64 严格地说，属于编码格式，而非加密算法MD5(Message Digest algorithm 5，信息摘要算法)SHA(Secure Hash Algorithm，安全散列算法)HMAC(Hash Message
JS：当前时间与时间戳的相互转换
weixin_43124539的博客
03-23 264
获取当前时间 new Date() 结果：Tue Mar 23 2021 15:44:44 GMT+0800 (中国标准时间) 获取当前时间的时间戳 Date.parse(new Date()) 结果：1616485615000 将时间戳转换成时间 new Date(1616485615000) 结果：Tue Mar 23 2021 15:46:55 GMT+0800 (中国标准时间) 将时间转换成时间戳 Date.parse(new Date(“2021-03-23 15:52:00”))..
给定n个字符串s[1...n], 求有多少个数对(i, j), 满足i ＜ j 且 s[i] + s[j] == s[j] + s[i]?
最新发布
way_back__的博客
01-12 503
由1、3可知a是b的前后缀，由2知b有一个周期是3，即a.size()，所以b是用多个a拼接而成的，有因为a是b的前后缀，所以a和b的循环节相同，且a，b均恰好由整数个循环节组成。循环节长度 = 字符串长度 - 最大公共前后缀长度。
通过命令行生成javadoc文档
Joy_Roy6的博客
02-20 271
1.新建一个类 2.选中类右键选择Show in Explorer 3.在目录里输入cmd 空格然后回车 4.输入javadoc -encoding UTF-8 -charset UTF-8 Demo04.java回车 出现以下内容 5.打开文件所在位置·，多了很多文件 打开index.html我们会发现 这样，我们使用命令行生成了javadoc文档。 ...
Javadoc写法和标签总结
wodongx123的博客
07-17 2324
文章目录1. Javadoc1.1 类标签1.2 方法标签1.3 其他标签2. HTML标签参考材料 1. Javadoc 先说一下如何用javadoc的注释，在方法的上面输入 /** 然后在敲下回车，就会自动生成一个javadoc格式的文档，然后就可以填内容了。 那么javadoc写法的注释和我们平时用的双斜杠//的注释有什么区别呢？ 最主要的区别就是javadoc的注释可以在我们鼠标放到方法名/类名/变量名上面的时候，直接看到其内容，而双斜杠的注释不行。 所以按照一般来说，我们会在类/变量/方法的
JavaDoc命令行操作
weixin_44564263的博客
04-20 1278
JavaDoc命令是用来生成自己的API文档的，API是什么？可以上网了解一下 （这个就是通过JavaDoc命令生成的API文档） 首先在IDEA中创建文件夹，在文件夹里面创建一个Doc.Java的文件，然后在里面该文件中写上几个方法或者是变量： 接下来去到文件资源管理器来找到在IDEA中编写完成的Doc.Java文件或者是在IDEA中选择到该文件右键找到打开该文件所在文件夹： （名字用的是中文是不推荐的） 在文件夹目录前面输入cmd加空格然后回车就能打开命令行也会来到该文件目...
javadoc命令使用
打怪升级
07-11 1067
javadoc命令使用
java table注解_java注解简单使用
weixin_30945845的博客
02-24 1383
java注解可以比喻成标签，可以贴在任何地方，也可以限制只能贴在固定地方，比如类上方、方法上方、属性[字段]上方等，然后通过反射，判断是否存在这个注解。注解形式public @interfaceTest {}应用//类上@Testpublic classEntity{//属性上@Testprivate intid;//方法上@Testpublic voidtest(){}}元注解元注解是什么意思呢...
xiexu-doc-20230619-生成Java文档注释文件
06-19
具体内容可参阅主页文章：【2023，学点儿新Java-09】Java初学者常会犯的错误总结与解决方案 | Java中的注释类型 | 详细教学：通过命令行 执行 Java中特有的文档注释
javadoc-coverage：生成JavaDoc覆盖率报告的Doclet
02-04
Doclet解析Java源文件并检查JavaDoc文档涵盖的Java代码的百分比，包括： 软件包（尚不支持Java 9模块） 类，内部类，接口和枚举 类属性 方法，参数，异常和返回值。 提供样本覆盖率报告。 当前的IDE会警告您...
javadoc转换成chm必备-jd2chm
10-29
1.javadoc转换成chm必备 ...3.拷贝jd2chm程序到javadoc文件夹（里面有index.html） 4.运行-->cmd到命令行下，转到javadoc文件夹 cd **/**/** 5.输入jd2chm 6.输入chm的名字（不能有空格！） OK
java学习及java学习代码.rar
06-25
适当添加注释信息，通过javadoc生成注释文档；为主方法传递参数“Hello world”字符串，并输出，记录操作过程。 public class Hello { public static void main(String args[]) { System.out.println(“Hello!”); }...
【Java】int、Integer、String的类型转换
热门推荐
星拱北辰的博客
01-25 1万+
本文分享int、Integer、String之间的类型转换方法
【Java】基本输入输出
星拱北辰的博客
02-07 1万+
本文深入剖析Java输入输出的那些细节
【Java】程序调试
星拱北辰的博客
03-05 1万+
本文介绍程序调试Debug相关内容
【Java】String的分割
星拱北辰的博客
03-05 1万+
本文分享三种java.lang.String的分割方法
【Java】BigDecimal的toString()与toPlainString()
星拱北辰的博客
03-03 1万+
本文比较java.math.BigDecimal的toString()与toPlainString()
java怎么自动生成文档注解
05-27
在Java中，可以使用Javadoc工具来自动生成文档注解。Javadoc工具是Java开发工具包（JDK）自带的一个工具，它可以根据源代码中的注释来生成HTML格式的API文档。 要在Java中生成文档注解，可以按照以下步骤进行操作：...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

星拱北辰

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值