Java注释分类

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

三大注释:

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

注释的注意事项:

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

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

注释的作用:

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

2.分析逻辑和理清思路

如何使用注释:

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

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

程序员最苦恼的2件事:

1.写注释

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

如何提升注释能力?

两个字,多写

相关推荐
柒.梧.34 分钟前
Java集合核心知识点深度解析:数组与集合区别、ArrayList原理及线程安全问题
java·开发语言·python
柒.梧.41 分钟前
Java基础高频面试题(含详细解析+易错点,面试必看)
java·开发语言·面试
佩奇大王42 分钟前
P593 既约分数
java·开发语言·算法
小同志001 小时前
软件测试周期 与 BUG
java·软件测试·bug·软件测试周期·bug等级
Han.miracle1 小时前
Spring IoC 容器与 Bean 管理核心考点解析
java·ioc·di
polaris06301 小时前
Java集合进阶
java·开发语言
tant1an1 小时前
Spring Boot 基础入门:从核心配置到 SSMP 整合实战
java·数据库·spring boot·sql·spring
客卿1231 小时前
力扣--组合,子集--回溯法的再探索--总结回溯法
java·算法·leetcode
毕设源码-赖学姐1 小时前
【开题答辩全过程】以 高校晚查寝系统为例,包含答辩的问题和答案
java
xiaoye37082 小时前
某大厂java面试题二面20260313
java·开发语言·spring