Java注释分类

Java注释:简单理解注释就是备份,注释的代码不会被计算机所执行

三大注释:

bash 复制代码
单行注释:
//
使用场景:注释信息比较少的时候,使用单行注释
快捷键:Ctrl+/
bash 复制代码
多行注释:
/*
*
*
...
*/
使用场景:注释信息比较多的时候,使用多行注释,并且用于方法内部(比如:main方法里面)
快捷键:Ctrl+shift+/
bash 复制代码
文档注释:
/**
*
*
...
*/
使用场景:用于对方法的介绍和类的介绍(用于方法头上或者类头上)
快捷键:先输入/**之后按回车

注释的注意事项:

1.文档注释和多行注释,开始行和结尾行【是包含,不是/* */外】不写注释信息(因为不满足规范,虽然不报错,但是影响美感)

2.文档注释和多行注释不能嵌套使用(会提示错误)

注释的作用:

1.提高代码的可读性和维护性 【维护性一般在别人代码基础上维护修改增加,如果他不写注释,有的地方就很愁人】
比如 :英语0基础的,在英语阅读翻译之后你背了100句,但是几个月之后看见同一片英语阅读,此时没有翻译,你还能一丝不苟的背出来吗?这就是为什么代码中需要注释

2.分析逻辑和理清思路

如何使用注释:

1.代码中需要用到新的知识点,此时涉及此代码必须要写注释,提高代码的可读性和维护性(就是养成习惯,否则后面很抗拒很难改回这好习惯)

2.编程前,建议先分析思路,在动代码(不然真的写代码就很痛苦了)

程序员最苦恼的2件事:

1.写注释

2.维护他人的代码,却看不见他写的注释

如何提升注释能力?

两个字,多写

相关推荐
ShiJiuD6668889996 分钟前
JSP Cookie和Session
java·开发语言
geNE GENT10 分钟前
Spring Boot 实战篇(四):实现用户登录与注册功能
java·spring boot·后端
FQNmxDG4S9 小时前
Java多线程编程:Thread与Runnable的并发控制
java·开发语言
虹科网络安全9 小时前
艾体宝干货|数据复制详解:类型、原理与适用场景
java·开发语言·数据库
axng pmje10 小时前
Java语法进阶
java·开发语言·jvm
rKWP8gKv710 小时前
Java微服务性能监控:Prometheus与Grafana集成方案
java·微服务·prometheus
老前端的功夫10 小时前
【Java从入门到入土】28:Stream API:告别for循环的新时代
java·开发语言·python
qq_4352879210 小时前
第9章 夸父逐日与后羿射日:死循环与进程终止?十个太阳同时值班的并行冲突
java·开发语言·git·死循环·进程终止·并行冲突·夸父逐日
小江的记录本10 小时前
【Kafka核心】架构模型:Producer、Broker、Consumer、Consumer Group、Topic、Partition、Replica
java·数据库·分布式·后端·搜索引擎·架构·kafka
yaoxin52112310 小时前
397. Java 文件操作基础 - 创建常规文件与临时文件
java·开发语言·python