javaDoc生成文档

最新推荐文章于 2024-10-14 00:00:00 发布

weixin_45737100

最新推荐文章于 2024-10-14 00:00:00 发布

阅读量76

点赞数

文章标签： java

本文链接：https://blog.csdn.net/weixin_45737100/article/details/123182461

版权

本文档介绍了如何使用JavaDoc工具为Java类和方法生成专业文档。示例中展示了`Doc`类及其`test`方法的注释，注释包含了作者、版本和异常处理等信息。通过命令行运行javadoc命令，可以将此类和方法的注释转化为结构化的API文档。

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

javaDoc生成文档

package com.lin.base;

//类注释
/**
 * @author Lin
 * @version 1.0
 * @since 1.8
 */
public class Doc {
    String name;

//方法注释
    /**
     * @author Lin
     * @param name
     * @return
     * @throws Exception
     */
    public String test(String name) throws Exception{
        return name;
    }


    //通过命令行 javadoc  参数  java文件

}