Java中的3种注释方法简述

Java注释，总共有3种注释方法

1、行注释

只能注释一行内容，用在注释信息内容少的地方。

在IDEA里的快捷键是：Ctrl + /

快捷键按一下注释，再按一下，取消注释。

// 注释内容

 

2、注释多行、块注释

在IDEA里的快捷键是：Ctrl +Shift+ /

快捷键按一下注释，再按一下，取消注释。

/*

注释内容

注释内容

注释内容

*/

3、文档注释

包含在“/**”和“*/”之间，也能注释多行内容，一般用在类、方法和变量上面，用来描述其作用。注释后，鼠标放在类和变量上面会自动显示出我们注释的内容。

在IDEA里的快捷键是：/**+Enter 。

快捷键按一下注释。仅这注释方法可以写入javadoc文档

/**

*注释内容

*...........

*/

以上三种注释的实例：

public class Demo {
    /**
     * @param args 这是一个实例
     * @auther 作者名
     * @Date 时间
     */
    public static void main(String[] args) {
        System.out.println("Hello world!"); // 输出Hello world!
        /*
        这是刚开始的代码
         */
    }
}

4、javadoc注释（文档注释）标签语法的一些说明。

javadoc注释标签语法的一些说明。（可以输入@，在加alt + /（补全键））

@author 作者名。可用于：类注释。

@deprecated 对类或方法的说明 该类或方法不建议使用,引起不推荐使用的警告

@exception 可能抛出异常的说明。可用于：方法注释。

@note 表示注解，暴露给源码阅读者的文档

@param 参数的说明。可用于：方法注释。

@return 返回值的说明。可用于：方法注释。

@remark 表示评论，暴露给客户程序员的文档

@see 生成文档中的“参见xx 的条目”的超链接，后边可以加上：“类名”、“完整类名”、“完整类名#方法”。可用于：类、方法、变量注释。

@since 表示从那个版本起开始有了这个函数

@version 版本信息。可用于：类注释。

5、注意事项

注释注释内容要简单、明了、含义准确，防止注释的多义性，错误的注释不但无益反而有害。