Java注释分类

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

三大注释:

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

注释的注意事项:

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

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

注释的作用:

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

2.分析逻辑和理清思路

如何使用注释:

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

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

程序员最苦恼的2件事:

1.写注释

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

如何提升注释能力?

两个字,多写

相关推荐
明洞日记10 分钟前
【设计模式手册007】原型模式 - 通过复制创建对象的艺术
java·设计模式·原型模式
源码君miui5208631 分钟前
JAVA国际版同城服务同城信息同城任务发布平台APP源码Android + IOS
android·java·ios
鹿衔`1 小时前
解决Flink on Yarn模式多Yarn Session会话提交
java·前端·flink
静若繁花_jingjing1 小时前
SpringBoot/SpringMvc/SpringCloud
java·spring boot·spring cloud
q***04631 小时前
【springboot】Spring 官方抛弃了 Java 8!新idea如何创建java8项目
java·spring boot·spring
稚辉君.MCA_P8_Java1 小时前
Sqoop 实现的功能是什么
java·服务器·架构·kubernetes·sqoop
w***4811 小时前
【Spring】IDEA中创建Spring项目
java·spring·intellij-idea
Thexhy1 小时前
Java大模型后端开发全流程指南
java·ai·大模型
從南走到北2 小时前
JAVA同城服务场馆预约门店预约健身房瑜伽馆预约系统支持H5小程序APP源码
java·开发语言·小程序
爱学的小码2 小时前
JavaEE初阶——多线程3(案例)
java·开发语言·单例模式·java-ee