如何通过javadoc命令生成.java源代码中的注释文档

第一步:只有以[/**]开头[*/]结尾的注释格式才会生成注释文档,代码如下:

/**
*@author  Elsa
*@version 1.0
*@date    2020-6-21
*/

public class Test
{
	public static void main(String[] args) 
	{
		System.out.println("Hello World!");
	}
}  

第二步:选择Test.java文件所在的路径(小编这里的文件放在了桌面上),然后打开DOS命令窗口,进行文档编译

C:\Users\smile\Desktop>javadoc -d help Test.java

上面的意思是:通过javadoc命令,选择的选项项为-d(directory,输出文件的目标目录),将Test.java文件中的注释编译到文件夹名为help里面。

具体的javadoc命令有那些选项,我们可以通过在DOS中输入javadoc -help来获取

如何通过javadoc命令生成.java源代码中的注释文档_第1张图片

第三步:打开help文件夹,查看里面的内容,以下是默认的输出内容。

如何通过javadoc命令生成.java源代码中的注释文档_第2张图片

第四步:打开index.html查看内容。

如何通过javadoc命令生成.java源代码中的注释文档_第3张图片

剩下的文件里面是什么,就要靠小伙伴们自己探索咯^_^

你可能感兴趣的:(Java)