登录
首页 >  文章 >  java教程

Java三种注释写法全解析

时间:2026-01-03 10:23:32 103浏览 收藏

IT行业相对于一般传统行业,发展更新速度更快,一旦停止了学习,很快就会被行业所淘汰。所以我们需要踏踏实实的不断学习,精进自己的技术,尤其是初学者。今天golang学习网给大家整理了《Java三种注释方式详解》,聊聊,我们一起来看看吧!

Java注释分为单行(//)、多行(/.../)和文档(/*.../)三种:单行仅限本行,多行可跨行但不支持嵌套,文档注释用于生成API文档并支持@param等标签。

Java里什么是注释_Java三种注释方式使用说明

Java里的注释是写在代码中、不参与编译执行的说明性文字,用来解释逻辑、标记待办、临时禁用代码等,提升可读性和协作效率。

单行注释(//)

以两个斜杠 // 开头,作用范围仅限当前行。适合简短说明或临时屏蔽一行代码。

  • 写在行首:// 计算用户登录失败次数
  • 写在代码右侧:int retryCount = 0; // 初始重试次数为0
  • 不能跨行,换行需重新加 //

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

/* 开始、*/ 结束,中间所有内容都被忽略,支持跨多行。适合稍长的说明或临时注释掉一段代码。

  • 可换行书写:/* 这里是登录校验逻辑
        包含密码强度检查和验证码验证 */
  • 不能嵌套:/* 外层注释 /* 内层会报错 */ 这样写是非法的 */
  • 常用于快速禁用几行代码,比逐行加 // 更方便

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

/** 开头、*/ 结尾,专为生成API文档设计(配合javadoc工具)。通常放在类、方法、字段前,支持特定标签如 @param@return@throws 等。

  • 示例:
    /**
      * 根据用户ID查询用户信息
      * @param userId 用户唯一标识
      * @return User对象,不存在返回null
      */
    public User findUserById(String userId) { ... }
  • IDE(如IntelliJ、Eclipse)能自动识别并提示文档内容
  • 不是所有注释都需写文档注释,只对需要公开或被他人调用的成员使用

注释不是越多越好,关键在准确、简洁、随代码更新。过时的注释比没有更误导人。

今天关于《Java三种注释写法全解析》的内容介绍就到此结束,如果有什么疑问或者建议,可以在golang学习网公众号下多多回复交流;文中若有不正之处,也希望回复留言以告知!

前往漫画官网入口并下载 ➜
相关阅读
更多>
最新阅读
更多>
课程推荐
更多>