Java注释分类

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

三大注释:

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

注释的注意事项:

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

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

注释的作用:

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

2.分析逻辑和理清思路

如何使用注释:

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

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

程序员最苦恼的2件事:

1.写注释

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

如何提升注释能力?

两个字,多写

相关推荐
冬夜戏雪11 小时前
[学习日记]看书笔记
java·学习
初级程序员Kyle12 小时前
开始改变第一天 JVM的原理到调优(2)
java·面试
程序员三明治12 小时前
Spring AOP:注解配置与XML配置双实战
java·后端·spring·代理模式·aop·1024程序员节
DKPT12 小时前
JVM直接内存和堆内存比例如何设置?
java·jvm·笔记·学习·spring
weixin_4365250713 小时前
若依 - idea集成docker一键部署springboot项目(docker-compose)
java·1024程序员节
鼠鼠我捏,要死了捏13 小时前
深入解析Java GC调优:从原理到实战
java·性能优化·gc调优
Live&&learn13 小时前
Tomcat 10和Tomcat 9引入servlet的不同
java·servlet·tomcat
siriuuus13 小时前
JVM 垃圾收集器相关知识总结
java·jvm
weixin_4365250713 小时前
Windows - Maven 安装到 IDEA 配置全流程
java·maven·intellij-idea