登录
首页 >  文章 >  前端

Java常用注释方法有哪些?怎么使用?

时间:2026-05-13 17:09:28 201浏览 收藏

Java提供了三种实用且不可或缺的注释方式:单行注释(//)适合快速说明某一行代码,多行注释(/*...*/)便于临时禁用代码块或添加段落式说明,而文档注释(/**...*/)则专为生成专业API文档设计,支持@param、@return等标准标签,大幅提升代码可维护性与团队协作效率——掌握它们虽不难,却是写出清晰、健壮、易扩展Java代码的第一步。

Java基础之有哪些注释方法?怎么用

Java 中有三种注释方式,分别是单行注释、多行注释和文档注释。它们用来给代码添加说明,提高可读性,且不会被编译器执行。

1. 单行注释(//)

使用两个斜杠 // 开始,从该位置到这一行的末尾都会被当作注释内容。

// 这是一个单行注释

int count = 0; // 表示计数器初始化

2. 多行注释(/\* ... \*/)

/* 开始,*/ 结束,中间的内容全部是注释,可以跨越多行。

/* 这是 一个多行注释 */

/* System.out.println("这段代码暂时不用"); */

3. 文档注释(/\*\* ... \*/)

/** 开始,*/ 结束,用于生成 API 文档。配合 javadoc 工具可提取类、方法、字段的说明。

/** * 计算两个整数的和 * @param a 第一个整数 * @param b 第二个整数 * @return 两数之和 */

public int add(int a, int b) { return a + b; }

文档注释通常写在类、方法或字段上方,支持特定标签如 @param、@return、@throws 等,帮助生成结构化文档。

基本上就这些,合理使用注释能让代码更清晰易懂。不复杂但容易忽略细节。

以上就是本文的全部内容了,是否有顺利帮助你解决问题?若是能给你带来学习上的帮助,请大家多多支持golang学习网!更多关于文章的相关知识,也可关注golang学习网公众号。

资料下载
相关阅读
更多>
最新阅读
更多>