1. Java的注释JavaDoc

Sturdy1

于 2020-01-09 16:01:03 发布

阅读量181

点赞数

CC 4.0 BY-SA版权

分类专栏： Java Note 文章标签： java

本文链接：https://blog.youkuaiyun.com/Sturdy1/article/details/103910079

Java Note 专栏收录该内容

15 篇文章

订阅专栏

本文详细介绍了Java中的三种注释方式：单行注释、多行注释及JavaDoc文档注释，并展示了如何使用JavaDoc生成类和方法的文档信息。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

package base;
//单行注释：注释一行    格式://
//多行注释：可注释多行  格式：/* */
      /*
      我是多行注释
      我是多行注释
      我是多行注释
       */
//JavaDoc(文档注释)：生成信息，还可以加注释描述类和方法的作用
    //放在类上面就生成类的信息;
    //放在方法上面就生成方法的信息.
/**JavaDoc：可以使用软件或cmd将代码和注释输出到HTML文件。*/
/*JavaDoc常用的参数：
    @author 作者名
    @version 当前版本号
    @return 返回值的情况
    @throws 异常抛出的情况
    @since 项目创建时的版本号
    @param 参数名
 */

/** 放在类上面就生成类的信息
 * @author Sturdy1
 * @version 1.0
 * @since 1.5         */
public class Demo10_doc {

    String name;

    /** 放在方法上面就生成方法的信息
     *
     * @param name
     * @return               */
    public String test(String name){
        return name;
    }
}

Idea生成JavaDoc时显示JDK path is not specified时的解决办法——转载