zl程序教程

您现在的位置是:首页 >  后端

当前栏目

java的三种代码注释方式「建议收藏」

JAVA代码 建议 收藏 方式 三种 注释
2023-06-13 09:12:14 时间

大家好,又见面了,我是你们的朋友全栈君。

1.注释的作用

注释是对程序语言的说明,有助于开发者之间的交流,方便理解和维护程序。注释不是编程语句,不会被编译器执行。一些代码量少较少的程序,我们加不加注释对我们的理解和修改代码没有太大影响;如果是淘宝;抖音等那种中大型程序,没有了代码注释,对于日后程序运行维护将是很大困难。我们可以在平时编码过程中养成规范代码注释习惯,也是我们成为优秀程序员的原因

2.java中的注释分类

Java中的注释分为以下三种:单行注释;多行注释;文档注释

1.单行注释

java代码中使用双斜杠单行注释//,一般单行注释,注释少量代码或者说明内容 ,格式为:

// 单行注释

2.多行注释

java代码中使用多行注释/* */,一般使用多行注释大量的代码或者说明内容 ,格式为:

/*

多行注释

多行注释

*/

3.文档注释

使用文档注释/** */,文档注释一般用于对类和方法进行功能说明 ,说明类的编写时间和作者以及方法作用参数和返回值

3.1类上的注释

/** * 类上的文档注释 * @author 张三 * @version 1.10.0 */

3.2方法上的注释

/** * 方法前的文档注释 * @param * @return * @throws */

标签

描述

@author

标识一个类的作者

@version

版本号

@since

当前文件使用jdk版本

@return

说明方法返回值类型

@param

说明一个方法的参数

@throws

抛出的异常

发布者:全栈程序员栈长,转载请注明出处:https://javaforall.cn/156322.html原文链接:https://javaforall.cn