05、 java 的三种注释及 javadoc 命令解析文档注释(即：java 特有注释方式)的过程

最新推荐文章于 2025-06-08 08:38:09 发布

狮子座的男孩

最新推荐文章于 2025-06-08 08:38:09 发布

阅读量1k

点赞数 38

CC 4.0 BY-SA版权

分类专栏： Java 文章标签： java 开发语言后端经验分享文档注释 javadoc java注释

本文链接：https://blog.csdn.net/weixin_43405300/article/details/138793262

Java 专栏收录该内容

24 篇文章 ¥9.90 ¥99.00

订阅专栏

超级会员免费看

本文详细介绍了Java的三种注释方式：单行注释、多行注释和文档注释（Javadoc）。单行和多行注释主要用于解释代码，不参与编译。Javadoc是Java特有的文档注释，可以被解析成HTML页面，用于生成程序的说明文档。文中还展示了如何使用Javadoc命令生成和查看注释文档。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

java的三种注释

1、单行注释：
- 其一、代码展示：
- 其二、特点：
2、多行注释：
- 其一、代码展示：
- 其二、特点：
3、文档注释(java特有)：
4、小结：

1、单行注释：

其一、代码展示：


public class HelloJava{
   
   

	public static void main(String[] args){
   
   
		//单行注释：如下的语句表示输出到控制台
		<

了解本专栏

订阅专栏解锁全文

超级会员免费看

确定要放弃本次机会？

福利倒计时

: :

立减 ¥

普通VIP年卡可用

立即使用

狮子座的男孩

关注关注

38
点赞
踩
28

收藏

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

复制链接

分享到 QQ

分享到新浪微博

扫一扫
打赏
打赏
打赏举报

举报

专栏目录

订阅专栏

Java程序中Doc（文档）注释详解

Jan's的博客

10-28

1万+

许多人写代码时总不喜欢写注释，每个程序员如此，嘿嘿，我也一样不过，话说回来，该写还是要写哦！没人会喜欢一个不写注释的程序员，当然，也没有一个喜欢写注释的程序员，今天，我们就来说说Java注释之一——Doc注释我们知道，Java支持 3 种注释，分别是单行注释、多行注释和文档注释，我们来看看他们的样子 //单行注释 /* 多行注释 */ /** *@... *.... *文档注释 */ 可能许多萌新不明白，写了这些注释有什么用呢？其实是因为初学者的代码量少，没有注释也能快速查找、修改.

javadoc注释规范.doc

10-09

javadoc注释规范.doc

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

Javadoc注释的用法

weixin_30892037的博客

10-04

196

【JAVA】javadoc —— 如何生成标准的 Java API 文档

最新发布

wangjinjin180的博客

06-08

566

javadoc是 Java 官方自带的文档生成工具，通过解析源代码中的特定注释格式，自动生成标准化的 HTML 格式 API 文档，方便开发者和用户阅读。

类注释文档编写方法

键者天行

07-21

7002

对于Java语言，最体贴的一项设计就是它并没有打算让人们为了写程序而写程序——人们也需要考虑程序的文档化问题。对于程序的文档化，最大的问题莫过于对文档的维护。若文档与代码分离，那么每次改变代码后都要改变文档，这无疑会变成相当麻烦的一件事情。解决的方法看起来似乎很简单：将代码同文档“链接”起来。为达到这个目的，最简单的方法是将所有内容都置于同一个文件。然而，为使一切都整齐划一，还必须使用一种特殊的注

Java教程:Javadoc（文档注释）详解

12-31

4376

本篇文章由泉州SEOwww.234yp.com 整理发布，Java教程www.234yp.com/Article/198092.html谢谢合作！Java教程Java 支持 3 种注释，分别是单行注释、多行注释和文档注释。文档注释以/**开头，并以*/结束，可以通过 Javadoc 生成 API 帮助文档，Java 帮助文档主要用来说明类、成员变量和方法的功能。文档注释只放在类、接口、成员变量、方法之前，因为 Javadoc 只处理这些地方的文档注释，而忽略其它地方的文档注释。 Javadoc 是...

Javadoc的注释方式

m0_73837751的博客

11-24

1502

***/@标签描述方法的参数。描述方法的返回值。描述方法可能抛出的异常。提供相关链接，用于引用类、方法或文档。标记方法或类已废弃，建议开发者避免使用。表示从哪个版本开始引入。@since 版本号嵌入式链接，用于引用类或方法。标注类或接口的作者。标注类的版本号。用于嵌入代码片段，常用于描述参数或示例。

xiexu-doc-20230619-生成Java文档注释文件

06-19

Java注释有三种基本类型：单行注释（//）、多行注释（/*...*/）和文档注释（/**...*/）。其中，文档注释是Java特有的，主要用于生成API文档。它的语法如下： ```java /** * 这是一个文档注释的例子。 * 它可以...

如何通过命令行生成Java文档注释完整教程

最后，文章给出了通过命令行执行Java特有的文档注释生成工具（javadoc）的方法，这也是生成Java文档注释文件的主流方式。" 知识点详细解释如下： 1. Java文档注释的作用：Java文档注释是JDK提供的一个工具，可以...

IntelliJ Javadoc注释神器：intellijautodoc深度解析

在Java开发过程中，编写Javadoc注释是生成API文档的重要步骤，它有助于开发者理解代码库的结构和使用方法。JAutodoc是一个流行的工具，能够基于类和方法自动生成Javadoc注释模板。本文介绍的intellijautodoc是一个受...

Java Javadoc自动化生成工具：提升API文档质量

1. Java文档注释标准Javadoc: Javadoc是Java语言特有的一个工具，用于从Java源代码中提取注释，并生成标准格式的文档。Javadoc注释通常被放置在类、接口、方法和字段声明之前，可以用来描述程序的结构和使用方法。...

javadoc 注解有哪些

weixin_40198093的博客

07-26

213

JavaDoc 注解概览及代码示例 JavaDoc 是 Java 编程语言的一个文档生成工具，它允许开发者从源代码中提取注释，并将这些注释转换成格式化的文档。JavaDoc 注解是 JavaDoc 工具用来增强文档内容的特殊注释。在本文中，我们将探讨一些常用的 JavaDoc 注解，并提供代码示例以及旅行图和饼状图的可视化...

javadoc注释规范

kelaocai

08-13

1162

javadoc做注释一. Java 文档 // 注释一行 /* ...... */ 注释若干行 /** ...... */ 注释若干行，并写入 javadoc 文档通常这种注释的多行写法如下： /** * ......... * ......... */ javadoc -d 文档存放目录 -author -version 源文件名.java 这条命令编译...

来看看Javadoc（文档注释）详解

weixin_42673574的博客

09-13

847

Java 支持 3 种注释，分别是单行注释、多行注释和文档注释。文档注释以/**开头，并以*/结束，可以通过 Javadoc 生成 API 帮助文档，Java 帮助文档主要用来说明类、成员变量和方法的功能。文档注释只放在类、接口、成员变量、方法之前，因为 Javadoc 只处理这些地方的文档注释，而忽略其它地方的文档注释。Javadoc 是 Sun 公司提供的一种工具，它可以从程序源代码中抽取类、方法、成员等注释，然后形成一个和源代码配套的 API 帮助文档。

JAVADOC注释详解

同是天涯程序猿

07-18

5730

java注释的分类 1、单行注释：int SUM = 100; //这是一个单行注释 2、多行注释： /* *这是一个多行注释 */ 3、文档注释： /** *这是一个文档注释 * @return a */ java注释和文档注释作为一个jav

Javadoc注释

2201_76092470的博客

07-13

1605

当使用Java编程语言开发项目时，我们通常会使用Javadoc工具来生成项目的文档。Javadoc是Java自带的一种文档生成工具，它可以根据代码中的注释生成HTML格式的文档，方便我们阅读和理解代码。

Javadoc文档注释

weixin_51984896的博客

09-10

341

【javadoc】Java文档注释法一）： 1)找到 Toos 选择 Generate Javadoc… 2)Output directory:(输出的位置)新建文件夹 3)Locale>> 地区：zh_CN 4)Other … arguments>> 编码：-encoding UTF-8 -charset UTF-8 注：{IntelliJ IDEA}app 法二）： 1）：)编辑好文件）打开cmd转到当前文件 2）：输入 javadoc -encoding UTF-8 -ch

Java Javadoc注释详解

积跬步，至千里

04-14

3235

javadoc是Sun公司提供的一个技术，它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说，只要在编写程序时以一套特定的标签作注释，在程序编写完成后，通过Javadoc就可以同时形成程序的开发文档了。javadoc标记javadoc标记包括。标记说明标记类型 @author 作者标记包、类、接口 @version 版本号

java doc 注解_Java doc注释

weixin_30128191的博客

02-24

542

常用Java注释标签(Java comment tags)@author 作者适用范围：文件、类、方法(多个作者使用多个@author标签标识，java doc中显示按输入时间顺序罗列。)例：* @author Leo. Yao@param 输入参数的名称说明适用范围：方法例：* @param str the String用来存放输出信息。@return 输出参数说明适用范围：方法例： ...