Java中的3种注释方法简述

左手的ㄟ右手 2023-10-14 12:41 14阅读 0赞

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 版本信息。可用于：类注释。

更多说明可参考： java文档注释（ [java文档注释\_java文档注释标签\_西晋的no1的博客-CSDN博客][java_java_no1_-CSDN] ）

## 5、注意事项 ##

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

[java_java_no1_-CSDN]: https://blog.csdn.net/xijinno1/article/details/130477217

发表评论取消回复

表情：

评论列表（有 0 条评论，14人围观）

还没有评论，来说两句吧...

相关阅读

相关 IDEA三种注释方法

1、单行注释（Ctrl+/）光标单击想要注释的行，按下Ctrl+/ ![5766fece98e448daa8957c32f3be6f32.png][] 2、多行注释（

小鱼儿/ 2024年04月01日 16:01/ 0 赞/ 106 阅读

相关 C语言中的3种注释方法

C语言中的3种注释方法 2021年8月28日星期六·席锦在用C语言编程时，常用的注释方式有如下几种： (1)单行注释 // … (2)多行注释 /\ … \/ (3

古城微笑少年丶/ 2024年03月27日 18:32/ 0 赞/ 88 阅读

相关 java中删除文件/文件夹的3种方法

1、通过io删除文件 / 通过递归逐层删除文件信息 @param filePath

ゝ一纸荒年。/ 2024年03月22日 21:08/ 0 赞/ 147 阅读

相关 Java中List排序的3种方法

在某些特殊的场景下，我们需要在 Java 程序中对 List 集合进行排序操作。比如从第三方接口中获取所有用户的列表，但列表默认是以用户编号从小到大进行排序的，而我们的系统需要

谁践踏了优雅/ 2024年03月17日 11:09/ 0 赞/ 88 阅读

相关 Java中的3种注释方法简述

Java注释，总共有3种注释方法 1、行注释只能注释一行内容，用在注释信息内容少的地方。在IDEA里的快捷键是：Ctrl + / 快捷键按一下注释，再按一下，取

左手的ㄟ右手/ 2023年10月14日 12:41/ 0 赞/ 15 阅读

相关 Java中List排序的3种方法！

![5a8964bd45b0cf7b7de61686684125e7.png][] 作者 | 王磊来源 | Java中文社群（ID：javacn666）转载请联

清疚/ 2023年10月01日 10:22/ 0 赞/ 48 阅读

相关 Java中List排序的3种方法

> Java中List排序方法其实有六种，今天先讲其中是三种。在某些特殊的场景下，我们需要在 Java 程序中对 List 集合进行排序操作。比如从第三方接口中获取所有用户的列

忘是亡心i/ 2023年09月26日 14:38/ 0 赞/ 113 阅读

相关 js的几种注释方法

1.单行注释： //我是单行注释 2.多行注释： /我是多行注释/ 3.文档注释 / test 这是一个测试函数 /

叁歲伎倆/ 2022年12月11日 13:49/ 0 赞/ 205 阅读

相关 mysql 注释几种方法

1. \ 注释内容 select \ from user \查询用户信息 2. -- 注释内容注意 --后有空格 select \ from user -- 查询用户

深藏阁楼爱情的钟/ 2022年05月22日 02:15/ 0 赞/ 287 阅读

相关 java中创建线程的3种方法

1.继承Thread类优点：可以直接使用Thread类中的方法，代码比较简单。缺点：继承Thread类之后不能继承其他类。 2.实现Runable接口优点：

╰+攻爆jí腚メ/ 2021年10月19日 00:34/ 0 赞/ 292 阅读