java注释和api文档以及注意事项

最新推荐文章于 2026-06-13 15:33:25 发布

原创最新推荐文章于 2026-06-13 15:33:25 发布 · 204 阅读

0 ·

本内容遵循CC 4.0 BY-SA版权协议

收录于

笔记

当前文章被收录于：

笔记

3 篇文章 0 人学习

订阅专栏查看详情

当前文章被以下社区和专栏收录：

本文介绍了Java中三种注释的使用方法：单行注释、多行注释及文档注释，并强调了文档注释的独特性和重要性。此外，还讲解了API文档的概念及其在软件开发中的作用。

java的注释有三种

第一:单行注释
//这是单行注释

第二:多行注释
/*
这是多行注释
*/

第三:文档注释
/**
这是文档注释
/

其中多行注释和文档注释有些类似，但是第三种是java独有的，它能以网页的方式进行查看

API
api文档等同于我们现实生活中你买的一辆组装玩具一样，每一个零件都需要操作说明书来描述他的意义，API文档就是这样的意思，同理API就是我们的应用程序接口

注意事项
注释的主要作用是在重要的地方进行一些备注说明，让其它开发者能更快的明白此处代码的作用。

确定要放弃本次机会？

福利倒计时

: :

立减 ¥

普通VIP年卡可用

立即使用

JAVA_mr.诸葛

关注关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
分享

复制链接

分享到 QQ

分享到新浪微博

扫一扫
举报

举报

专栏目录

Java 注释

wjs2024的博客

03-14

299

Java 注释是 Java 编程语言中不可或缺的一部分，它有助于提高代码的可读性、可维护性和可复用性。在实际开发中，我们应该合理使用注释，以提高代码质量。

java注解

lastingboy的博客

01-11

1168

客户端传JSON数据给服务端，服务端要把JSON数据接成javabeen对象，这时我们要用@RequestBody注解，就可以把客户端传过来的JSON数据转换成javabeen对象。如果我们希望spring也能管理某一个类的对象，除了打上@Component注解之外，还可以使用@Import注解在配置类引入它。@ResponseBody 是可以写在方法上，也可以写在类上，如果标记在类上，即表示对所有的方法都生效！搭配@Autowired使用，用来告诉@Autowired，要根据指定的id去找对象注入！

参与评论您还未登录，请先登录后发表或查看评论

Java的注释注意细节

努力笨小孩的博客

10-15

300

（1）单行注释：使用 // （2）多行注释：使用 /* */ 注意：单行注释不能嵌套多行注释（是因为如果嵌套第二个多行注释，编译器就会认为第内层多行注释的结尾就是外层多行注释的结尾，而原本外层的结尾编译器就不知道是什么了，就会报错，如下图）（3）文档注释会生成一个文档，一般用在类的前面；里面含有javadoc标签（如@author，可以在源码中查看例子）把文档注释生成文档的过程（注意如果出现乱码请修改文本编辑器的设置文件编码GBK） javadoc -d E:\java...

Java注释的注意事项

pattyi的博客

03-14

571

Java注释的注意事项 注释是否可以嵌套单行注释可以嵌套，多行注释不可以嵌套，文档注释不可以嵌套。多行注释、文档注释可以嵌套单行注释。 //这是一个单行注释 //这也是一个单行注释可以嵌套 /* 这是一个多行注释这也是属于多行注释的范围 */ /** 这是文档注释这也属于文档注释的一部分 @author Amministrator @version 1.0 */ 快捷键单行注释 Ctrl+/ 多行注释添加：Ctrl+Shift+/ 取消：Ctrl+Shift+\ 文档注释

Java(四)——Java的文档注释（使用javadoc工具生成API文档）

热门推荐

Undergoer的博客

01-26

1万+

Java注释编写程序时，总要为程序添加一些注释，用以说明某段代码的作用，或者某个类的用途、某个方法的功能，以及该方法的参数及返回值的意义。为什么要编写注释？主要有一下几个方面的考虑： -永远不要过于相信自己的理解能力。当你思路流畅，进入变成境界时，你可能很快地实现某个功能。但在以后再次阅读这段代码时，可能会不知其所以然，因此为了时刻找回当初编程时的思路，建议编写注释。 -可读性第一

java入门——注释与API文档

weixin_48719464的博客

11-20

268

②注释内容可以被JDK提供的工具javadoc所解析，生成一套以网页文件形式体现的该程序的说明文档。换句话说，编译以后生成的.class 结尾的字节码文件中不包括注释掉的信息。API文档：针对于提供的类库如何使用，给的一个说明书，类似于《新华字典》作用： ①对所写的程序进行解释说明，增强可读性。①单行注释和多行注释，注释了的内容不参与编译。文档注释：/** */多行注释：/* */③多行注释不可以嵌套使用。习惯上：将语言提供的类库，都称为api。1.注释：Comment。分类：单行注释：//

Javadoc（文档注释）详解

Itmastergo的博客

11-23

1575

Javadoc 是 Sun 公司提供的一种工具，它可以从程序源代码中抽取类、方法、成员等注释，然后形成一个和源代码配套的 API 帮助文档。也就是说，只要在编写程序时以一套特定的标签注释，在程序编写完成后，通过 Javadoc 就形成了程序的 API 帮助文档。

Java注释详解：单行、多行与文档注释的区别与应用

weixin_74120671的博客

06-02

1342

Java注释使用指南摘要：本文详细解析Java三种注释方式。单行注释(//)适合简短说明，多行注释(/.../)用于代码块说明，文档注释(/**...*/)专门生成API文档。文档注释支持@param、@return等标签，可通过javadoc工具生成HTML文档。最佳实践建议：public类和方法应使用文档注释，代码逻辑优先自解释，注释需及时更新。避免过度注释和嵌套多行注释。合理运用注释能提升代码可维护性，是团队协作的重要保障。

教你如何为你的代码自动生成API文档（文档注释）！

koveerKV的博客

11-18

1240

帮助你在IDEA中自动生成文档注释，养成良好的代码注释习惯。

Java - 注释的最佳实践

业精于勤荒于嬉

07-19

353

Java 程序开发中注释的最佳实践

Java单行、多行和文档注释！Java入门 Java基础

qq_24428851的博客

12-14

361

在编写Java的过程中，我们需要对一些程序进行注释。除了方便自己阅读之外，我们还需要为他人更好地理解我们的程序。因此，我们需要对一些程序进行注释，这些注释可以是编程思想，也可以是程序的作用，可以说是Java入门基础了！想知道更多Java基础内容可以参考以下视频 ↓ ↓ ↓注释不是编程语句，因此被编译器忽略。总之，这对我们自己和其他人来说都是很方便的，希望大家都可以养成随手注释的好习惯，这样就算过了很久也可以根据注释内容来区分内容！

java笔记——Java注释

azrealq的博客

03-28

140

1.单行注释 //单行注释 2.多行注释 /* 多行注释多行注释 */ 注：多行注释不可以嵌套使用 3.文档注释 /** @author 指定Java程序作者 @version 指定源文件的版本这是我的程序 */ 注：文档注释可以被javadoc工具解析生成网页文件形式的说明文档 ...

【Java 注释】

qq_33445829的博客

02-11

320

为了方便程序的阅读，Java语言允许程序员在程序中写上一些说明性的文字，用来提高程序的可读性，这些文字性的说明就称为注释注释不会出现在字节码文件中，即Java编译器编译时会跳过注释语句在Java中根据注释的功能不同，主要分为单行注释、多行注释和文档注释单行注释单行注释使用“//”开头，“//”后面的单行内容均为注释多行注释多行注释以“/*”开头以“*/”结尾，在“/*”和“*/”之间的内容为注释，我们也可以使用多行注释作为行内注释。但是在使用时要注意，多行注释不能嵌套使用文档注.

【JAVA】基础学习02文本运行及文档注释

weixin_63505616的博客

03-05

1183

java的文本运行以及文档注释等

【Java笔记】01 概述

wusandaofwy的博客

02-25

274

全称Java Development Kit，java开发工具包 JDK=JRE+java的开发工具java，javac，javadoc,javap等。注释内容可以被jdk提供的工具javadoc所解析，生成一套以网页形式体现的该程序的说明文档，一般写在类。解释性：编译后的代码，不能直接被机器执行，需要解释器来执行,javascript,PHP,java。编译后每一个类都对应一个.class。\r：一个回车，光标移到行首，\r后面的替换\r前部分字符。编译性：编译后的代码，可以直接被机器执行，c/c++

第56项：为所有导出的API元素编写文档注释

Coloured_Glaze的博客

07-13

382

如果要想使一个API真正可用，就必须为其编写文档。传统意义上的API文档是手工生成的，所以保持文档与代码同步是一件很繁琐的事情。Java编程环境提供了一种被成为Javadoc的实用工具。Javadoc使用特殊格式的文档注释（documentation comments）（通常称为doc注释（doc comments））从源代码自动生成API文档。虽然这些文档注释规范不是Java语言正式的...

java如何制作帮助文档_使用javadoc命令制作帮助文档（API）

weixin_39523887的博客

02-25

763

测试代码如下： 1、生成帮助文档的方法：①、打开DOS窗口；②、定位到到该类的源文件所在文件夹；③、输入命令：javadoc -d c:\help -author -version Test.java对命令的说明：-d：其后空一格，用来指定生成的帮助文档存放的位置；-author：用来指定生成的帮助文档必须显示该类的作者，如果没有这一命令则生成的帮助文档将不会显示作者；-version：用来指定生...

java中的注释