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

2024-05-13 19:04

本文主要是介绍05、 java 的三种注释及 javadoc 命令解析文档注释(即:java 特有注释方式)的过程,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

java的三种注释

  • 1、单行注释:
    • 其一、代码展示:
    • 其二、特点:
  • 2、多行注释:
    • 其一、代码展示:
    • 其二、特点:
  • 3、文档注释(java特有):
    • 其一、代码展示:
    • 其二、注释文档的使用:
    • 其三、html 页面打开注释文档:
  • 4、小结:

1、单行注释:

其一、代码展示:


public class HelloJava{public static void main(String[] args){//单行注释:如下的语句表示输出到控制台//System.out.println("Hello World!")System.out.println("Hello World!");}
}

其二、特点:

A、单行注释的形式: //

B、单行注释的作用:
step1、对所写的程序进行解释说明,增强可读性。方便自己,方便别人;
step2、调试所写的代码;

C、单行注释的特点:
// 注释了的内容不参与编译(即:能调试代码的原理)
// 即:若注释该行代码后,运行程序不报错,那么就能调试代码找到报错的原因(因此:就实现了调试代码的操作);

// 换句话说:编译以后生成的 .class 结尾的字节码文件中不包含单行注释掉的信息;

2、多行注释:

其一、代码展示:


public class HelloJava{/*多行注释:如下的main方法是程序的入口!main的格式是固定的!*/public static void main(String[] args){System.out.println("Hello World!");}
}

其二、特点:

A、多行注释的形式: /* */

B、多行注释的作用:
step1、对所写的程序进行解释说明,增强可读性。方便自己,方便别人;
step2、调试所写的代码;

C、多行注释的特点:

// 注释了的内容不参与编译(即:能调试代码的原理)
// 即:若注释该行代码后,运行程序不报错,那么就能调试代码找到报错的原因(因此:就实现了调试代码的操作);

// 换句话说:编译以后生成的 .class 结尾的字节码文件中不包含单行注释掉的信息;

D、注意:多行注释不可以嵌套使用

// 即:多行注释不能再嵌套多行注释使用;
// 而多行注释里面可以嵌套单行注释使用,但是感觉不必要;

3、文档注释(java特有):

其一、代码展示:


/**
文档注释
@author shkstart
@version v1.0
这是我的第一个java程序!非常的开森!*/
public class HelloJava{/**如下的方式是main(),作用:程序的入口。注意:编译的时候不写 main() 函数没问题,但运行的时候不写 main() 函数就会报错,因为 main() 函数是程序的入口;*/public static void main(String[] args){System.out.println("Hello World!");}
}

其二、注释文档的使用:

A、特点:
// 注释内容可以被 JDK 提供的工具 javadoc 所解析,生成一套以网页文件形式体现的该程序的说明文档;

// 注意:在 javadoc 解析的类,通常会添加 public 属性值(如:public class HelloJava{} );

B、执行 javadoc 的命令:

// 输入的命令:javadoc -d myHello -author -version HelloJava.java

// myHello 是指:生成文件夹的名称;
// HelloJava.java 是指:待运行的 .java 文件;

// 而在 myHello 文件夹中,有很多 html 格式文件,而打开其中的 index.html 文件就能看到版本信息;

C、注释文档的用途:
// 文档注释的用途:代码比较多的时候,用 javadoc 一解析,就会将写好的功能列出来,就可以通过文档注释的方式,来明白写的方法是做什么用的;

其三、html 页面打开注释文档:

A、代码中注释文档的内容:

// 即:注释文档的地方;
在这里插入图片描述

B、在对应的 .java 文件执行命令:

// 即:就在 HelloJava.java 文件所在目录,执行 javadoc -d myProject -author -version HelloJava.java 命令:

// 而生成的文件夹为 myProject

在这里插入图片描述

C、在 myProject 文件夹中用浏览器打开 index.html 文件:

在这里插入图片描述

在这里插入图片描述

D、用浏览器打开 index.html 中注释文档的效果展示:

// 第一处:用文档注释的信息展示:

在这里插入图片描述

// 第二处:用文档注释的信息展示:

在这里插入图片描述

4、小结:

其一、哪里有不对或不合适的地方,还请大佬们多多指点和交流!
其二、若有转发或引用本文章内容,请注明本博客地址(直接点击下面 url 跳转) https://blog.csdn.net/weixin_43405300,创作不易,且行且珍惜!

这篇关于05、 java 的三种注释及 javadoc 命令解析文档注释(即:java 特有注释方式)的过程的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/986559

相关文章

Java中对象的创建和销毁过程详析

《Java中对象的创建和销毁过程详析》:本文主要介绍Java中对象的创建和销毁过程,对象的创建过程包括类加载检查、内存分配、初始化零值内存、设置对象头和执行init方法,对象的销毁过程由垃圾回收机... 目录前言对象的创建过程1. 类加载检查2China编程. 分配内存3. 初始化零值4. 设置对象头5. 执行

SpringBoot整合easy-es的详细过程

《SpringBoot整合easy-es的详细过程》本文介绍了EasyES,一个基于Elasticsearch的ORM框架,旨在简化开发流程并提高效率,EasyES支持SpringBoot框架,并提供... 目录一、easy-es简介二、实现基于Spring Boot框架的应用程序代码1.添加相关依赖2.添

通俗易懂的Java常见限流算法具体实现

《通俗易懂的Java常见限流算法具体实现》:本文主要介绍Java常见限流算法具体实现的相关资料,包括漏桶算法、令牌桶算法、Nginx限流和Redis+Lua限流的实现原理和具体步骤,并比较了它们的... 目录一、漏桶算法1.漏桶算法的思想和原理2.具体实现二、令牌桶算法1.令牌桶算法流程:2.具体实现2.1

SpringBoot中整合RabbitMQ(测试+部署上线最新完整)的过程

《SpringBoot中整合RabbitMQ(测试+部署上线最新完整)的过程》本文详细介绍了如何在虚拟机和宝塔面板中安装RabbitMQ,并使用Java代码实现消息的发送和接收,通过异步通讯,可以优化... 目录一、RabbitMQ安装二、启动RabbitMQ三、javascript编写Java代码1、引入

spring-boot-starter-thymeleaf加载外部html文件方式

《spring-boot-starter-thymeleaf加载外部html文件方式》本文介绍了在SpringMVC中使用Thymeleaf模板引擎加载外部HTML文件的方法,以及在SpringBoo... 目录1.Thymeleaf介绍2.springboot使用thymeleaf2.1.引入spring

Java实现检查多个时间段是否有重合

《Java实现检查多个时间段是否有重合》这篇文章主要为大家详细介绍了如何使用Java实现检查多个时间段是否有重合,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录流程概述步骤详解China编程步骤1:定义时间段类步骤2:添加时间段步骤3:检查时间段是否有重合步骤4:输出结果示例代码结语作

Java中String字符串使用避坑指南

《Java中String字符串使用避坑指南》Java中的String字符串是我们日常编程中用得最多的类之一,看似简单的String使用,却隐藏着不少“坑”,如果不注意,可能会导致性能问题、意外的错误容... 目录8个避坑点如下:1. 字符串的不可变性:每次修改都创建新对象2. 使用 == 比较字符串,陷阱满

Java判断多个时间段是否重合的方法小结

《Java判断多个时间段是否重合的方法小结》这篇文章主要为大家详细介绍了Java中判断多个时间段是否重合的方法,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录判断多个时间段是否有间隔判断时间段集合是否与某时间段重合判断多个时间段是否有间隔实体类内容public class D

IDEA编译报错“java: 常量字符串过长”的原因及解决方法

《IDEA编译报错“java:常量字符串过长”的原因及解决方法》今天在开发过程中,由于尝试将一个文件的Base64字符串设置为常量,结果导致IDEA编译的时候出现了如下报错java:常量字符串过长,... 目录一、问题描述二、问题原因2.1 理论角度2.2 源码角度三、解决方案解决方案①:StringBui

Java覆盖第三方jar包中的某一个类的实现方法

《Java覆盖第三方jar包中的某一个类的实现方法》在我们日常的开发中,经常需要使用第三方的jar包,有时候我们会发现第三方的jar包中的某一个类有问题,或者我们需要定制化修改其中的逻辑,那么应该如何... 目录一、需求描述二、示例描述三、操作步骤四、验证结果五、实现原理一、需求描述需求描述如下:需要在