當(dāng)前位置：首頁(yè) > 编程语言 > java >内容正文

java

【Java】命令行生成JavaDoc文档

發(fā)布時(shí)間：2025/3/15 java 24 豆豆

生活随笔收集整理的這篇文章主要介紹了【Java】命令行生成JavaDoc文档小編覺(jué)得挺不錯(cuò)的,現(xiàn)在分享給大家,幫大家做個(gè)參考.

編寫(xiě)簡(jiǎn)單的文檔注釋

安利 → 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");} }

開(kāi)辟一個(gè)新的文件夾

跳轉(zhuǎn)到指定區(qū)域并生成文檔

JavaDocTest.java文件放到D:\JavaDocTest路徑下。

cmd輸入D: ，從C盤(pán)切到D盤(pán)。

輸入命令cd D:\JavaDocTest，跳轉(zhuǎn)到指定路徑下。

輸入命令javadoc JavaDocTest.java，生成文檔注釋（無(wú)須提前編譯好）。

發(fā)現(xiàn)生成的一系列文件

還挺豐富orz

-html5

在Java8→Java9的時(shí)候，加上-html5會(huì)表示使用HTML5的規(guī)范，但現(xiàn)在我用的Java11，我總覺(jué)得是默認(rèn)了HTML5規(guī)范……
我這是寫(xiě)的還算規(guī)范，你要是寫(xiě)的不合規(guī)范的話，javadoc命令執(zhí)行的時(shí)候會(huì)報(bào)警告或者報(bào)錯(cuò)。

查看文檔內(nèi)容

查看網(wǎng)頁(yè)源碼

<!DOCTYPE HTML>  <html lang="zh"> <head>  <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>  <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"> 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">  <div class="topNav"><a id="navbar.top">  </a> <div class="skipNav"><a href="#skip.navbar.top" title="跳過(guò)導(dǎo)航鏈接">跳過(guò)導(dǎo)航鏈接</a></div> <a id="navbar.top.firstrow">  </a> <ul class="navList" title="導(dǎo)航"> <li><a href="package-summary.html">程序包</a></li> <li class="navBarCell1Rev">類</li> <li><a href="package-tree.html">樹(shù)</a></li> <li><a href="deprecated-list.html">已過(guò)時(shí)</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"> </script> <noscript> <div>您的瀏覽器已禁用 JavaScript。</div> </noscript> </div> <div> <ul class="subNavList"> <li>概要: </li> <li>嵌套 | </li> <li>字段 | </li> <li><a href="#constructor.summary">構(gòu)造器</a> | </li> <li><a href="#method.summary">方法</a></li> </ul> <ul class="subNavList"> <li>詳細(xì)資料: </li> <li>字段 | </li> <li><a href="#constructor.detail">構(gòu)造器</a> | </li> <li><a href="#method.detail">方法</a></li> </ul> </div> <a id="skip.navbar.top">  </a></div>  </div> <div class="navPadding"> </div> <script type="text/javascript"> </script> </nav> </header>  <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">  <section role="region"> <ul class="blockList"> <li class="blockList"><a id="constructor.summary">  </a> <h3>構(gòu)造器概要</h3> <table class="memberSummary"> <caption><span>構(gòu)造器</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">構(gòu)造器</th> <th class="colLast" scope="col">說(shuō)明</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"> </td> </tr> </table> </li> </ul> </section>  <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"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">靜態(tài)方法</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">具體方法</a></span><span class="tabEnd"> </span></span></caption> <tr> <th class="colFirst" scope="col">修飾符和類型</th> <th class="colSecond" scope="col">方法</th> <th class="colLast" scope="col">說(shuō)明</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>(java.lang.String[] 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>從類繼承的方法 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">  <section role="region"> <ul class="blockList"> <li class="blockList"><a id="constructor.detail">  </a> <h3>構(gòu)造器詳細(xì)資料</h3> <a id="<init>()">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>JavaDocTest</h4> <pre>public JavaDocTest()</pre> </li> </ul> </li> </ul> </section>  <section role="region"> <ul class="blockList"> <li class="blockList"><a id="method.detail">  </a> <h3>方法詳細(xì)資料</h3> <a id="main(java.lang.String[])">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>main</h4> <pre class="methodSignature">public static void main(java.lang.String[] args)</pre> <div class="block">Default method to be run to print 'Hello World'<p>Hello world</p></div> <dl> <dt><span class="paramLabel">參數(shù):</span></dt> <dd><code>args</code> - command line arguments</dd> </dl> </li> </ul> </li> </ul> </section> </li> </ul> </div> </div> </main>  <footer role="contentinfo"> <nav role="navigation">  <div class="bottomNav"><a id="navbar.bottom">  </a> <div class="skipNav"><a href="#skip.navbar.bottom" title="跳過(guò)導(dǎo)航鏈接">跳過(guò)導(dǎo)航鏈接</a></div> <a id="navbar.bottom.firstrow">  </a> <ul class="navList" title="導(dǎo)航"> <li><a href="package-summary.html">程序包</a></li> <li class="navBarCell1Rev">類</li> <li><a href="package-tree.html">樹(shù)</a></li> <li><a href="deprecated-list.html">已過(guò)時(shí)</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"> </script> <noscript> <div>您的瀏覽器已禁用 JavaScript。</div> </noscript> </div> <div> <ul class="subNavList"> <li>概要: </li> <li>嵌套 | </li> <li>字段 | </li> <li><a href="#constructor.summary">構(gòu)造器</a> | </li> <li><a href="#method.summary">方法</a></li> </ul> <ul class="subNavList"> <li>詳細(xì)資料: </li> <li>字段 | </li> <li><a href="#constructor.detail">構(gòu)造器</a> | </li> <li><a href="#method.detail">方法</a></li> </ul> </div> <a id="skip.navbar.bottom">  </a></div>  </nav> </footer> </body> </html>

總結(jié)

雖然我們使用javadoc命令完成了整個(gè)的文檔生成，但我們至少親手操作了一次IDE幫我們省略的工作，雖不復(fù)雜，但很棒的不是嗎？

我們不能只會(huì)使用IDE這種開(kāi)發(fā)工具，越是強(qiáng)大的IDE，往往越是隱去了更多我們的基本操作，對(duì)于掌握知識(shí)未必是好事。

總結(jié)

以上是生活随笔為你收集整理的【Java】命令行生成JavaDoc文档的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問(wèn)題。

如果覺(jué)得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。

上一篇：【算法分析与设计】基数排序
下一篇：【数据结构与算法】布谷鸟散列表的Java