Java基础:JavaDoc生成文档

最新推荐文章于 2025-04-01 20:05:02 发布

原创最新推荐文章于 2025-04-01 20:05:02 发布 · 277 阅读

3 ·

CC 4.0 BY-SA版权

文章标签：

#java

Java 同时被 2 个专栏收录

63 篇文章

订阅专栏

java基础

4 篇文章

订阅专栏

本文介绍了一个简单的Java类，该类包含使用JavaDoc注释的方法和属性。文章演示了如何利用IDEA等工具来生成JavaDoc文档，这对于提高代码可读性和维护性非常重要。

package javaDoc生成文档;
 //@author  作者名
 //@version 版本号
 //@since   指明需要最早使用的jdk版本
//@param    参数名
//@return   返回值情况
//@throws   异常抛出情况
/**
 * @author Bubbles
 * @version 1.0
 * @since  1.8
 */
public class Demo1 {
    //属性
    String name;
    //方法

    /**
     * @author Bubbles
     * @param name
     * @return
     * @throws Exception
     */
    public  String test(String name) throws Exception{
        return  name;
    }
  //重点:学会查找使用IDEA生产javaDoc文档！
}