《JAVA 基础： 注释、文档》

最新推荐文章于 2022-10-27 12:07:24 发布
最新推荐文章于 2022-10-27 12:07:24 发布
阅读量128 收藏
点赞数
分类专栏： 【 Java_Scala 基础 】
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/yexiangCSDN/article/details/107406507
版权
本文详细介绍了Java的三种注释方式：单行注释、多行注释和文档注释，强调了注释在提高代码可读性和方便调试中的作用。特别是文档注释，其内容可以通过Javadoc工具生成API文档。此外，还讲解了Javadoc命令的使用，包括IDEA和Eclipse中生成Javadoc的步骤，并提及了Javadoc的常用标记和查看其使用说明的方法。
摘要由CSDN通过智能技术生成

一、注释

Java规范的三种注释方式：

  • 单行注释   //
  • 多行注释  /*   */
  • 文档注释(java特有)  /**   */
     

单行注释和多行注释的作用：

  • 对所写的程序进行解释说明，提高代码的阅读性。方便自己，方便别人阅读以及调试所写的代码
  • 单行注释和多行注释注释的内容不参与编译，换句话说，编译以后生成的.class结尾的字节码文件中不包含注释掉的信息

文档注释的使用：</

了解本专栏 订阅专栏 解锁全文
HarkerYX
关注
专栏目录
订阅专栏
【Java注释:单行 多行 文档注释】
qq_61341033的博客
06-25 1692
注释是程序语言的说明,它有助于开发者之间的交流,方便解释程序.注释在程序语言中不会被视作代码,不会执行,而被编译器忽视.Java中,注释可分为三类以双斜杠杠"//"为标识,但是智能注释一行内容,用于注释信息内容较少的情况,不使用于注释大幅度的文章 2.多行注释 由"/* */"和包裹起来的注释为多行注释,适用于注释文字幅度篇幅较大的情况注:多行只是可以嵌套单行注释,但不能嵌套多行注释和文档注释 3.文档注释 包含在"/** */"之间,也能注释多行内容,一般在类,方法和变量上面,用来描述器作用注:文档
【Java】文档注释
chengwei1128的博客
02-14 5464
文章目录1.概念2. 简单使用演示3. Java的文档注释的基本格式4. javadoc的常用标签 1.概念 文档注释：在程序中采用特定的注释格式进行注释，然后通过JDK提供的工具javadoc来解析，生成一套以网页文件形式体现的程序说明文档。一般写在类。 2. 简单使用演示 演示程序DocComment.java： /** * @author 小明 * @version 1.0 */ public class DocComment{ public static void main(S
Java 文档注释
unber的博客
10-27 1784
Java 支持三种注释方式。前两种分别是//和/* */，第三种被称作说明注释，它以/**开始，以*/结束。
java文档注释
gpu40200的博客
09-08 1779
java个人笔记
java文档注释return_Java-文档注释
weixin_31904867的博客
02-27 1349
Java-文档注释Java语言支持三种类型的注释-Sr.No.Comment & Description1/* text */The compiler ignores everything from /* to */.2//textThe compiler ignores everything from // to the end of the line.3/** documentatio...
java多行注释_Java注释：单行、多行和文档注释
weixin_28876083的博客
02-12 7262
注释是对程序语言的说明，有助于开发者和用户之间的交流，方便理解程序。注释不是编程语句，因此被编译器忽略。Java支持以下三种注释方式：1)单行注释以双斜杠“//”标识，只能注释一行内容，用在注释信息内容少的地方。打开 Eclipse，在 Java 代码中使用单行注释，如图 1 所示。图 1 单行注释2)多行注释包含在“/*”和“*/”之间，能注释很多行的内容。为了可读性比较好，一般首行和尾行不写注...
Java的文档注释
Moum_j的博客
05-12 5330
这一段时间在看Java源码以及别人的一些代码时总会看到一些用 @ 修饰的东西。以前最熟悉的就是@override重写，但当我看到这个 真的可以说是被“震惊”了，所以打算来学习一下Java的文档注释。 Java 支持三种注释方式。前两种分别是 // 和 /* */，第三种被称作说明注释，它以 /** 开始，以 ***/**结束，前两种都是都是非常熟悉的了，最有意思的是第三种说明注释。 Java标签 这里只列举几个常见的Java标签 标签 描述 示例 @author 标识一个类的作者 @aut
Java-文档注释
热门推荐
道阻且长，行则将至。
08-21 1万+
1 Java注释概述 Java的三种注释： （1）单行注释：// 注释内容 （2）多行注释：/… 注释内容…./ （3）文档注释：/*.. 注释内容…./ （这种注释可以用来自动地生成文档。在JDK中有个javadoc的工具，可以由源文件生成一个HTML文档。使用这种方式注释源文件的内容，显得很专业，并且可以随着源文件的保存而保存起来。也就是说，当修改源文件时...
Java注释：单行、多行和文档注释
languan1639397的博客
01-18 3739
注释是对程序语言的说明，有助于开发者和用户之间的交流，方便理解程序。注释不是编程语句，因此被编译器忽略。Java支持以下三种注释方式： 1）单行注释 以双斜杠“//”标识，只能注释一行内容，用在注释信息内容少的地方。打开 Eclipse，在 Java 代码中使用单行注释，如图 1 所示。 图 1 单行注释 2）多行注释 包含在“/*”和“*/”之间，能注释很多行的内容。为了可读性比较好，一般首行和尾行不写注释信息（这样也比较美观好看），如图 2 所示。 注意：多行注释可以嵌套单行注释...
Java之生成文档注释
哈希不Map的博客
09-04 1234
在实际开发中，我们经常需要生成文档注释，下面简单记录一下如何生成文档注释，以下是使用EditPlus编写的java文档生成的注释。 帮助文档: 1)使用JDK,JDK中类有很多,都可以使用,了解这些类的使用方式,类的功能,变量,方法,怎么使用, JDK给开发人员提供了帮助文档 API 2)自己的项目中,开发的功能,需要给客户提供对应的操作手册,方便客户进行功能的运行 注释: 文档注释,注释中包含了...
Java经验点滴:类注释文档编写方法
01-01
对于Java语言，最体贴的一项设计就是它并没有打算让人们为了写程序而写程序——人们也需要考虑程序的文档化问题。对于程序的文档化，最大的问题莫过于对文档的维护。若文档与代码分离，那么每次改变代码后都要改变...
Java：Java 的注释用法
最新发布
01-13
总结来说，Java 中的注释分为单行、多行和文档注释三种类型，每种都有其特定的使用场景。单行注释用于快速简单的注解，多行注释适合解释复杂的代码段，而文档注释则用于生成对外部可见的 API 文档，提高代码的可读性...
Java-文档注释例子
09-04
1. 提供自动生成API文档：Java的Javadoc工具可以读取源代码中的文档注释，生成HTML格式的文档，方便开发者理解和使用API。 2. 提高代码可读性：通过添加详细的描述，让其他开发者更容易理解代码的功能和用法。 3. ...
Java的文档注释之生成帮助文档的实例
08-28
在Java编程语言中，文档注释（Javadoc）是一种特殊类型的注释，专门设计用于生成程序的API文档。它能够帮助开发者理解代码的功能、参数、返回值以及作者和版本信息等，极大地提高了代码的可读性和维护性。下面我们将...
Java基础--注释
qq_45028878的博客
02-10 478
注释 平时我们编写代码，在代码量比较少的时候，还可以看得懂自己写的，但当项目结构一旦复杂起来，我们就需要用到注释了 注释并不会被执行 书写注释是一个非常好的习惯 平时写代码一定要注意规范 Java中的注释有三种： 单行注释 多行注释 文档注释 idea注释颜色修改 public class HelloWorld { public static void main(String[] args){ //单行注释 双斜杠开头 //
《JAVA： 学习导图》
yexiangCSDN的专栏
07-13 2147
《JAVA： 学习导图》 预计： 2020.8.1-2020.12.31 完成 ，待定！
《大数据： Scala 客户信息管理软件》
yexiangCSDN的专栏
12-30 892
一 、项目需求 模拟实现一个基于文本界面的《客户信息管理软件》，该软件能够实现对客户对象的插入、修改和删除（用数组实现），并能够打印客户明细表 1. 需求说明 主菜单： 每个客户的信息被保存在Customer对象中 以一个Customer类型的数组来记录当前所有的客户 每次“添加客户”（菜单1）后，客户（Customer）对象被添加到数组中 每次“修改客户”（菜单2）后，修改后的客户（Customer）对象替换数组中原对象 每次“删除客户”（菜单3）后，客户（Customer）对象被从数组
《JAVA 进阶： 网络编程》
yexiangCSDN的专栏
07-29 493
一、网络编程概述 Java是 Internet 上的语言，它从语言级上提供了对网络应用程序的支持，程序员能够很容易开发常见的网络应用程序。 Java提供的网络类库，可以实现无痛的网络连接，联网的底层细节被隐藏在 Java 的本机安装系统里，由 JVM 进行控制。并且 Java 实现了一个跨平台的网络库，程序员面对的是一个统一的网络编程环境。 计算机网络： 把分布在不同地理区域的计算机与专门的外部设备用通信线路互连成一个规模大、功能强的网络系统，从而使众多的计算机可以方便地互相传递信息、共享硬件、软.
《JAVA 基础： 项目一：模拟账户》
yexiangCSDN的专栏
07-21 457
1. 写一个名为Account的类模拟账户 该类的属性和方法如下图所示。该类包括的属性：账号id，余额balance，年利率annualInterestRate；包含的方法：访问器方法（getter和setter方法），取款方法withdraw()，存款方法deposit()。 Account private int id private double balance private double annualInterestRate pu
"Java编程基础：注释与文档
其中，注释是Java程序中非常重要的一部分，主要有单行注释、多行注释和文档注释三种类型。单行注释以//表示，多行注释以/* */表示，文档注释以/** */表示。注释的作用在于提高程序的可读性，使程序结构更清晰易懂，...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

HarkerYX

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值