Javadoc说明

最新推荐文章于 2023-12-26 20:06:05 发布

一什么欧

最新推荐文章于 2023-12-26 20:06:05 发布

阅读量99

点赞数

本文链接：https://blog.csdn.net/weixin_44199948/article/details/113815786

版权

JAVA 专栏收录该内容

67 篇文章 0 订阅

订阅专栏

本文档介绍了如何使用命令行和IDEA生成Java项目的Javadoc。通过在`Doc.java`类中添加注释，然后使用`javadoc`命令或者IDEA的`Generate JavaDoc`功能，可以生成详细的API文档。在生成过程中，注意指定字符编码和避免包含测试源代码。生成的Javadoc文件夹中，`doc.html`是主要的入口文件，可用于查阅类和方法的详细信息。

摘要由CSDN通过智能技术生成

Javadoc说明

创建Doc.java

package com.caster.base;//包机制

/**
 * 类注释
 */
public class Doc {
    String name;

    /**方法注释
     * @author caster
     * @version 1.0
     * @param name 参数名
     * @return
     * @throws Exception
     */
    public String test(String name)throws Exception{
        return name;
    }
}

使用命令行生成javadoc

打开文件所在目录最前面加上cmd 用命令行打开
输入javadoc -encoding UTF-8 -charest UTF-8 Doc.java
等待生成…
目录出现了一大堆新的文件，打开doc.html

使用IDEA生成javadoc

打开 idea，点击 Tools-> Generate JavaDoc，这样会打开生成 javadoc 文档的配置页面。
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-v7kwb9h8-1613369371915)(C:\Users\Administrator\Desktop\3386108-df6d8ebe7dc9acf0.webp)]
-encoding UTF-8 -charest UTF-8 Doc.java
不要勾选“Include test sources”，勾选后，生成时会造成很奇怪的错误。
点击生成

注：ctrl + 左键查看详细

alt + enter 查看帮助