Java的三种注释 Javadoc标记*

最新推荐文章于 2025-08-09 16:16:23 发布
原创 最新推荐文章于 2025-08-09 16:16:23 发布 · 138 阅读 · 0 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#java

这篇博客主要讨论了信息技术领域的关键话题，包括前端开发、后端开发、移动开发等方面的技术应用和最新趋势。作者深入探讨了各种编程语言、框架和工具的使用，并提到了数据安全、人工智能以及自动化测试等重要议题。
Java注释的三种形式：单行、多行、文档注释的实际应用
记录学习的过程
05-13 995
Java提供了三种注释形式：单行注释、多行注释和文档注释，每种形式都有其特定的应用场景和最佳实践。单行注释以//开头，适用于简短说明、调试代码或标记待办事项；多行注释以/* ... */包裹，适合复杂算法说明或临时注释大段代码；文档注释以/** ... */标记，用于生成API文档，支持HTML标签和多种Javadoc标签。在实际项目中，开发者应根据需求选择合适的注释形式，保持代码的可读性和可维护性。
Java的三种注释
Memory1011的博客
10-16 122
转自：http://www.pinlue.com/article/2020/10/1214/5311288229904.html
java中的注释以及标识符
qq_55824997的博客
11-07 277
java中的注释有三种 单行注释 // 注释 多行注释 /* 注释 */ 文档注释 /** 注释 */ 标识符 关键字 标识符大小写敏感 所有标识符都应该以字母，美元符，或者下划线开始 不能使用关键字作为变量名或方法 不建议使用中文命名，也不建议用拼音命名 ...
Java注释中的方法文档标记
灿灿大王搭建的黄金屋
02-13 1990
除嵌入 HTML 和@see 引用之外，方法还允许使用针对参数、返回值以及违例的文档标记。 1、 @param 格式如下：  @param 参数名 说明 其中，“参数名”是指参数列表内的标识符，而“说明”代表一些可延续到后续行内的说明文字。一旦遇到 一个新文档标记，就认为前一个说明结束。可使用任意数量的说明，每个参数一个。 2、 @return 格式如下： @return 说明 其中，“说...
java 注释标签_JAVA文档注释标签
weixin_42523389的博客
02-12 830
1常用Java注释标签(Java comment tags)@author作者@param输入参数的名称说明@return输出参数说明@since JDK版本@version版本号@see链接目标@throws异常@deprecated解释@link链接地址2 Java注释的使用顺序3简单常见的HTML嵌入4HTML嵌入注释范例5参考文档1常用Java注释标签...
java笔记3----java注释、标识符和关键字
qq_43303414的博客
01-13 202
java注释、java标识符和关键字
java的文档注释/**...*/是什么
最新发布
11-16
- **包含描述和块标记**：文档注释由描述部分和特定的块标记（如`@param`、`@return`、`@see`等）组成，用于详细说明代码元素的功能、参数、返回值等。 3. **与普通注释的区别**： - 文档注释`/**...*/`会被`...
精选资源
javadoc2swagger：将Javadoc转换为-读取自定义javadoc标记并生成一个swagger文件
02-04
Maven插件，用于从JAX-RS和Javadoc注释生成Swagger 这个Maven插件正在为基于JAX-RS的Java服务器生成Swagger API文档。 JAX-RS批注中未包含的... 第三，如果同时使用Javadoc和Swagger注释来记录代码，则会有冗余数据
10、Java 文档注释（Javadoc）：提升代码可维护性的利器
yog99的博客
08-09 60
本文深入介绍了 Java 中的文档注释工具 Javadoc，强调了其在提升代码可维护性和团队协作中的重要作用。文章详细讲解了 Java 注释的种类、Javadoc 的使用方法以及其对面向对象编程的支持，并通过一个 `Player` 接口的完整示例，展示了如何编写高质量的文档注释。此外，还分析了 Javadoc 在实际项目中的应用场景，提出了编写优质文档的实用建议，帮助开发者养成良好的文档编写习惯，提升项目质量。
Java文档注释与javadoc工具详解
Java支持三种注释方式：行内注释（//）、块注释（/* */）以及文档注释（/** */）。文档注释，又称为Javadoc注释，它的主要目的是为了生成易于理解的、结构化的HTML文档，以便其他开发者能够更好地了解和使用你的代码...
【Java】Java注释 - 单行、块、文档注释
渐若窥宏大的博客
11-23 2182
简单记录，Java 核心技术卷I 基础知识（原书第10 版） 注释 我们在编写程序时，经常需要添加一些注释，用来描述某段代码的作用，提高Java源程序代码的可读性，使得Java程序条理清晰。 写代码的时候应遵循注意一些java规范，函数短小精悍，用清晰的命名来解释代码， 整洁的代码， 不要保留不用的代码（注释代码），要么删掉，要么想到更好的方案替换，别留着，注释不要写废话和错误的。 那为什么要写注...
Java常用注释
qq_42730111的博客
09-30 759
Java注释
Java注解详解
u013773608的博客
04-08 1232
Java注解又称Java标注，是在 JDK5 时引入的新特性，注解（也被称为元数据）。Java注解它提供了一种安全的类似注释的机制，用来将任何的信息或元数据（metadata）与程序元素（类、方法、成员变量等）进行关联。Java注解是附加在代码中的一些元信息，用于一些工具在编译、运行时进行解析和使用，起到说明、配置的功能。
Java的几种注释方法
2403_89347326的博客
07-30 262
注释一般是为了让自己写的代码能够被更容易的读懂而附加的描述信息，不参与编译运行，但是可以节省很多阅读上的功夫。比如在文档注释注释方法里面套用多行注释，此时文档注释的结束标志会被多行注释的*/给抢占，使得文档注释后面的注释内容失效。常见于描述方法和类的作用，能够被javadoc工具解析，生成一套以网页文件形式体现的程序说明文档。:写法是在要注释内容的开头和结尾分别加上/*和*/:写法是在要注释文档的开头加上/** 结尾加上*/:写法就是在要注释的内容前面加上双斜杠//比如 /*我是注释*/
JAVA中如何写注释
程序员大腾的博客
12-04 3410
JAVA中如何写注释。 注释的格式说明。
alibb java_阿里巴巴Java开发手册-注释规约
weixin_29751415的博客
02-23 1235
1. 【强制】类、类属性、类方法的注释必须使用Javadoc规范，使用/**内容*/格式，不得使用//xxx方式。说明：在IDE编辑窗口中，Javadoc方式会提示相关注释，生成Javadoc可以正确输出相应注释；在IDE中，工程调用方法时，不进入方法即可悬浮提示方法、参数、返回值的意义，提高阅读效率。2. 【强制】所有的抽象方法(包括接口中的方法)必须要用Javadoc注释、除了返回值、参数、异...
3、Java注释（单行注释，多行注释，文档注释）（超详细版本）
颜安青的小世界
04-19 8838
注释内容可以被JDK提供的工具javadoc所解析，生成一套以网页文件形式（.html）体现的该程序的说明文档，只放在类、接口、成员变量、方法之前（因为Javadoc只处理这些地方的文档注释，而忽略其他地方的文档注释）如果出现图片上的错误，是因为cmd进入的入口错误，要真正找到Hello.java存放的文件地址才可以，eg：从E:\code\JavaLearn 变成从 E:\code\JavaLearn\src进去。3）文档注释：以/**开始， 以*/结束。大家一起学，一起进步！2）多行注释：/**/
Java中的注释和注解——原理介绍与使用详解
m0_53926113的博客
10-29 1810
注释是给开发人员看的，帮助我们或其他人理解代码的结构、目的或逻辑，尤其是在代码复杂的情况下，注释可以提供非常有用的信息。注解看上去和注释很相似，都是一种附加在代码上的信息，但注解其实是给编译器、虚拟机或框架看的，具有更深层次的功能。一些常用的、非自定义的标准注解，JVM会自动处理它们的逻辑，开发者不需要额外编写代码来处理。这个注解在运行时可通过反射读取，广泛用于需要运行时动态行为的场景，如Spring等框架。简单来说，注解是给编译器或工具看的，而注释是给人看的，二者在代码中扮演的角色完全不同。
Java 中的注释有哪些？
weixin_44798281的博客
05-13 1566
在编写 Java 程序时，注释是很重要的，它可以让程序更加易读、易懂，也可以提高程序的可维护性和可重用性。因此，程序员在编写代码时应该注意添加适当的注释，使代码更加清晰易懂。在 Java 中，有三种注释方式：单行注释、多行注释和文档注释。注释是程序中的一种重要的辅助性说明文字，可以增加程序的可读性和可维护性，方便其他程序员阅读和理解代码。单行注释通常用来对代码进行短暂的说明，或者是对代码进行临时的注释或调试。多行注释通常用来对代码进行详细的解释和说明，或者是暂时注释掉一段代码。
评论 1
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
表情包 代码片
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值