【Java】命令行生成JavaDoc文档

编写简单的文档注释

安利 → JavaDoc文档注释详解

/**
  * @author BlankSpace
  * @version 1.0
  */
public class JavaDocTest {
    /**
     * Default method to be run to print 'Hello World'
     * 
Hello world
     * @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命令执行的时候会报警告或者报错。

查看文档内容

查看网页源码

JavaDocTest














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');

您的浏览器已禁用 JavaScript。








跳过导航链接




程序包
类
树
已过时
索引
帮助




所有类


SEARCH:








您的浏览器已禁用 JavaScript。




概要: 
嵌套 | 
字段 | 
构造器 | 
方法


详细资料: 
字段 | 
构造器 | 
方法







 







类 JavaDocTest



java.lang.Object


JavaDocTest







public class JavaDocTest
extends java.lang.Object












构造器概要

构造器 

构造器
说明


JavaDocTest()
 











方法概要

所有方法 静态方法 具体方法 

修饰符和类型
方法
说明


static void
main​(java.lang.String[] args)

Default method to be run to print 'Hello World'







从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
















构造器详细资料
">>()">




JavaDocTest
public JavaDocTest()











方法详细资料





main
public static void main​(java.lang.String[] args)
Default method to be run to print 'Hello World'
 Hello world

参数:
args - command line arguments


















跳过导航链接




程序包
类
树
已过时
索引
帮助




所有类





您的浏览器已禁用 JavaScript。




概要: 
嵌套 | 
字段 | 
构造器 | 
方法


详细资料: 
字段 | 
构造器 | 
方法

总结

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

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