当前位置:首页 > 文章列表 > 文章 > java教程 > Java三种注释写法全解析

Java三种注释写法全解析

2026-01-03 10:23:32 0浏览 收藏

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学习网公众号下多多回复交流;文中若有不正之处,也希望回复留言以告知!

Go语言错误处理技巧与实战Go语言错误处理技巧与实战
上一篇
Go语言错误处理技巧与实战
JavaScriptCanvas轻量游戏引擎教程
下一篇
JavaScriptCanvas轻量游戏引擎教程
查看更多
最新文章
查看更多
课程推荐
  • 前端进阶之JavaScript设计模式
    前端进阶之JavaScript设计模式
    设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
    543次学习
  • GO语言核心编程课程
    GO语言核心编程课程
    本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
    516次学习
  • 简单聊聊mysql8与网络通信
    简单聊聊mysql8与网络通信
    如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
    500次学习
  • JavaScript正则表达式基础与实战
    JavaScript正则表达式基础与实战
    在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
    487次学习
  • 从零制作响应式网站—Grid布局
    从零制作响应式网站—Grid布局
    本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
    485次学习
查看更多
AI推荐
  • ChatExcel酷表:告别Excel难题,北大团队AI助手助您轻松处理数据
    ChatExcel酷表
    ChatExcel酷表是由北京大学团队打造的Excel聊天机器人,用自然语言操控表格,简化数据处理,告别繁琐操作,提升工作效率!适用于学生、上班族及政府人员。
    3545次使用
  • Any绘本:开源免费AI绘本创作工具深度解析
    Any绘本
    探索Any绘本(anypicturebook.com/zh),一款开源免费的AI绘本创作工具,基于Google Gemini与Flux AI模型,让您轻松创作个性化绘本。适用于家庭、教育、创作等多种场景,零门槛,高自由度,技术透明,本地可控。
    3774次使用
  • 可赞AI:AI驱动办公可视化智能工具,一键高效生成文档图表脑图
    可赞AI
    可赞AI,AI驱动的办公可视化智能工具,助您轻松实现文本与可视化元素高效转化。无论是智能文档生成、多格式文本解析,还是一键生成专业图表、脑图、知识卡片,可赞AI都能让信息处理更清晰高效。覆盖数据汇报、会议纪要、内容营销等全场景,大幅提升办公效率,降低专业门槛,是您提升工作效率的得力助手。
    3768次使用
  • 星月写作:AI网文创作神器,助力爆款小说速成
    星月写作
    星月写作是国内首款聚焦中文网络小说创作的AI辅助工具,解决网文作者从构思到变现的全流程痛点。AI扫榜、专属模板、全链路适配,助力新人快速上手,资深作者效率倍增。
    4914次使用
  • MagicLight.ai:叙事驱动AI动画视频创作平台 | 高效生成专业级故事动画
    MagicLight
    MagicLight.ai是全球首款叙事驱动型AI动画视频创作平台,专注于解决从故事想法到完整动画的全流程痛点。它通过自研AI模型,保障角色、风格、场景高度一致性,让零动画经验者也能高效产出专业级叙事内容。广泛适用于独立创作者、动画工作室、教育机构及企业营销,助您轻松实现创意落地与商业化。
    4137次使用
微信登录更方便
  • 密码登录
  • 注册账号
登录即同意 用户协议隐私政策
返回登录
  • 重置密码