Java注释分类

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

三大注释:

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

注释的注意事项:

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

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

注释的作用:

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

2.分析逻辑和理清思路

如何使用注释:

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

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

程序员最苦恼的2件事:

1.写注释

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

如何提升注释能力?

两个字,多写

相关推荐
范纹杉想快点毕业5 分钟前
实战级ZYNQ中断状态机FIFO设计
java·开发语言·驱动开发·设计模式·架构·mfc
smileNicky31 分钟前
布隆过滤器怎么提高误差率
java
それども33 分钟前
分库分表的事务问题 - 怎么实现事务
java·数据库·mysql
Java面试题总结1 小时前
基于 Java 的 PDF 文本水印实现方案(iText7 示例)
java·python·pdf
马猴烧酒.1 小时前
【面试八股|Java集合】Java集合常考面试题详解
java·开发语言·python·面试·八股
测试工程师成长之路1 小时前
Serenity BDD 框架:Java + Selenium 全面指南(2026 最新)
java·开发语言·selenium
lang201509281 小时前
Java JSON绑定API:JSR 367详解
java·java-ee
eWidget1 小时前
随机森林原理:集成学习思想 —— Java 实现多棵决策树投票机制
java·数据库·随机森林·集成学习·金仓数据库
xqqxqxxq2 小时前
Java Thread 类核心技术笔记
java·笔记
LGL6030A2 小时前
Java学习历程26——线程安全
java·开发语言·学习