首页
学习
活动
专区
圈层
工具
发布

Java中的注释

单行注释 写法: //此行后面均是注释内容 例如://我是一行注释|´・ω・)ノ 多行注释 写法: /* 我是注释内容1 我是注释内容2 */ 单/多行注释的作用: 增强代码的可读性 文档注释...写法: /** *我是文档注释内容 */ 文档注释的作用: 注释允许你在程序中嵌入关于程序的信息。...你可以使用 javadoc 工具软件来生成信息,并输出到HTML文件中。 说明注释,使你更加方便的记录你的程序信息。...javadoc标签 在开始的 /** 之后,第一行或几行是关于类、变量和方法的主要描述。 之后,你可以包含一个或多个各种各样的 @ 标签。...每一个 @ 标签必须在一个新行的开始或者在一行的开始紧跟星号(*). 多个相同类型的标签应该放成一组。例如,如果你有三个 @see 标签,可以将它们一个接一个的放在一起。 示例:

2.2K20
  • 您找到你想要的搜索结果了吗?
    是的
    没有找到

    IDEA插件:快速删除Java代码中的注释

    背景 有时,我们需要删除Java源代码中的注释。目前有不少方法,比如: 实现状态机。该方式较为通用,适用于多种语言(取决于状态机支持的注释符号)。 正则匹配。该方式容易误判,尤其是容易误删字符串。...该方式局限性较强,比如不同语言可能有不同的第三方库。 本文针对Java语言,介绍一种利用第三方库的方式,可以方便快速地移除代码中的注释。 原理 这个第三方库叫做JavaParser。...它可以分析Java源码,并生成语法分析树(AST),其中注释也属于AST中的节点。 因此核心思路即为: JavaParser解析源码并得到AST。 识别出注释类型的节点并将其删掉。...将AST中剩余的节点按一定规则打印出来。 在实践之前,我们先要了解Java中的几种注释类型: LineComment 单行注释。 BlockComent 块注释。...String s3 = "/** 我是字符串中的内容,不是注释 */"; } } 下面我们实践一下,看看怎么移除源码中的注释。

    4K00

    IDEA插件:快速删除Java代码中的注释

    背景 有时,我们需要删除Java源代码中的注释。目前有不少方法,比如: 实现状态机。该方式较为通用,适用于多种语言(取决于状态机支持的注释符号)。 正则匹配。...该方式局限性较强,比如不同语言可能有不同的第三方库。 本文针对Java语言,介绍一种利用第三方库的方式,可以方便快速地移除代码中的注释。 原理 这个第三方库叫做JavaParser。...它可以分析Java源码,并生成语法分析树(AST),其中注释也属于AST中的节点。 因此核心思路即为: JavaParser解析源码并得到AST。 识别出注释类型的节点并将其删掉。...将AST中剩余的节点按一定规则打印出来。 在实践之前,我们先要了解Java中的几种注释类型: LineComment 单行注释。 BlockComent 块注释。...下面我们实践一下,看看怎么移除源码中的注释。

    3.4K30

    协程中的取消和异常 | 取消操作详解

    ⚠️ 为了能够更好地理解本文所讲的内容,建议您首先阅读本系列中的第一篇文章: 协程中的取消和异常 | 核心概念介绍。...有时候,您也许仅仅需要取消其中某一个协程,比如用户输入了某个事件,作为回应要取消某个进行中的任务。...有关如何执行此操作的更多信息,请参考下面的处理取消的副作用一节。 在底层实现中,子协程会通过抛出异常的方式将取消的情况通知到它的父级。父协程通过传入的取消原因来决定是否来处理该异常。...处于取消中状态的协程不能够挂起 当协程被取消后需要调用挂起函数,我们需要将清理任务的代码放置于 NonCancellable CoroutineContext 中。...这样会挂起运行中的代码,并保持协程的取消中状态直到任务处理完成。

    3.3K20

    java注释

    定义这个规范的目的是让项目中所有的文档都看起来像一个人写的,增加可读性,减少项目组中因为换人而带来的损失。(这些规范并不是一定要绝对遵守,但是一定要让程序有良好的可读性)。...Java 的语法与 C++ 及为相似,那么,你知道 Java 的注释有几种吗?是两种?   ...注释的内容要清楚、明了,含义准确,防 止注释二义性。保持注释与其描述的代码相邻,即注释的就近原则。 对代码的注释应放在其上方相邻位置,不可放在下面。...对数据结构的注释应放在 其上方相邻位置,不可放在下面;对结构中的每个域的注释应放在此域的右方; 同一结构中不同域的注释要对齐。 变量、常量的注释应放在其上方相邻位置或右方。...@author 对类的说明 标明开发该类模块的作者 @version 对类的说明 标明该类模块的版本 @see 对类、属性、方法的说明 参考转向,也就是相关主题 @param 对方法的说明 对方法中某参数的说明

    43400

    java注释

    java基础 java是一门基于c研发的语言,不同但相似,针对java下面介绍java的一些基本知识: java注释 在编写程序时,注释可以帮助我们迅速了解到自己代码的含义,在大型项目中也需要注释帮助我们回忆并查找代码...java注释分为三种: 单行注释 // 多行注释 /* */ 文档注释 /** */ 标记符和关键字 java的关键字具有特殊含义,除关键字外其他字均可以作为标记符; 关键字不需要一次性记住,在后面我会慢慢讲述...数据类型 数据名 【=值】 java变量分为三种变量: 类变量:直接在类中以static开头创建:static int a; ​ 可在方法中直接输出 实例变量: 在类中直接创建:int...b;数值类初始化为0,bool类型初始化为flase; ​ 在方法使用时需要先建立一个变量类型的变量,才能使用该变量中的实例变量 ​ 变量类型 变量名 = new 变量类() ​...变量名.实例变量 局部变量:在方法中定义的变量,只能在该方法中使用 常量 常量就是一旦定义不能改变的量 常量定义方法:final Name = value 变量常量命名规则 见名知意:尽量以英文命名

    1.4K20

    Java注释说明以及IDEA中的快捷键

    一、单行注释 说明:单行注释 一般注释少量的代码或者说明内容 格式://注释的内容 IDEA中的快捷键:使用Ctrl+ /, 添加行注释,再次使用,去掉行注释 二、多行注释 说明:多行注释 一般注释大量的代码或者说明内容...格式:/*注释的内容*/ IDEA中的快捷键:使用 Ctrl+Shift+ /, 添加块注释,再次使用,去掉块注释;*/ 三、文档注释 说明:文档注释 一般用于对类和方法进行功能说明 格式:/**注释的内容...*/ IDEA中的快捷键:IDEA中文档注释快捷键 : 输入/** ,点击“Enter”,自动根据参数和返回值生成注释模板 1、类、接口上常用的标注 /** 类、接口上常用的标注 *...conf.DbConfig #另请参阅,链接到其它类|接口的文档 * @deprecated #不推荐使用 * */ 2、方法上常用的标注 /*...IOException #抛出的异常 * @exception IOException #也可以用此标记来说明抛出的异常 * @see conf.DbConfig

    1.5K10
    领券