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
相关文章
- dos命令运行java代码_如何制作ddos攻击
- Java代码实现文件上传「建议收藏」
- java scanner怎么用_Java中Scanner类的用法及使用步骤分享!「建议收藏」
- java backoff_Java BackOff类代码示例
- java冒泡排序经典代码_Java 8大经典排序算法(含源代码),必须收藏!
- java代码大全及详解_Java练级攻略[通俗易懂]
- java后端开发需要学什么_从事Java后端开发,要学习哪些知识和技能?[通俗易懂]
- java平均的随机数_Java 随机数详解「建议收藏」
- java 汉字乱码_Java中文乱码问题
- java验证手机号正则表达式_Java使用正则表达式验证手机号和电话号码的方法「建议收藏」
- Java入门代码_java编程自学网
- java list 转json 字符串_Java之JSON字符串与List集合之间相互转换
- java解释器虚拟机-Java代码如何运行在Java虚拟机中
- Java 代码审计基础知识 — java反射机制
- Java程序员如何优雅操作Redis(java操作redis)
- 时间设置Java代码实现Redis Key自动过期(redisjava过期)
- Java运行在Linux系统上免费下载(linux java下载)
- Java开发与Linux运维的高效协作(java与linux运维)
- Linux测试搭配Java快速实现稳定性验证(linux测试java)
- Java迭代Oracle实现数据库更高性能(java迭代oracle)
- 异常Java程序捕获Oracle异常从失败中学习(java捕获oracle)
- 并发Redis锁保障Java并发性(redis锁实现java)