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,创作不易,且行且珍惜!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/pingmian/11588.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

掌握Vim:Linux系统维护的瑞士军刀 - 常用命令深度解析

在Linux的世界里,Vim编辑器犹如一位沉默的剑客,它的命令就是那锋利的剑刃,能够在代码的海洋中劈波斩浪。对于每一位Linux系统用户来说,掌握Vim的常用命令,就如同获得了维护系统的瑞士军刀。今天,让我们一起…

Java中,throw和throws的区别是什么?

在Java中,throw和throws都与异常处理相关,但它们的作用和使用方式有所不同。 throw 抛出异常:throw是一个语句,用于在程序的特定位置手动抛出一个异常对象。局部范围内:throw通常用在方法体或任何代码块的内部&#…

Rumor Remove Order Strategy on Social Networks

ABSTRACT 谣言被定义为广泛传播且没有可靠来源支持的言论。现代社会,谣言在社交网络上广泛传播。谣言的传播给社会带来了巨大的挑战。 “假新闻”故事可能会激怒您的情绪并改变您的情绪。有些谣言甚至会造成社会恐慌和经济损失。因此,谣言的影响可能是深…

Flutter 中的 Autocomplete 小部件:全面指南

Flutter 中的 Autocomplete 小部件:全面指南 在 Flutter 中,Autocomplete 是一个文本输入辅助小部件,它可以根据用户输入的内容提供自动完成建议。这在创建搜索栏、填写表单或其他需要快速输入的场景中非常有用。虽然 Flutter 的基础库中没有…

深入解析C#中的async和await关键字

文章目录 一、异步编程的基本概念及其在C#中的实现二、async关键字的定义及其用法三、await关键字的定义及其用法示例代码:使用async和await编写一个简单的异步程序 四、async和await的优点注意事项 五、C#下async和await中常见问题汇总1. 异步方法中的await调用2. …

STM32(GPIO)

GPIO简介 GPIO(General Purpose Input Output)通用输入输出口 引脚电平:0V~3.3V,部分引脚可容忍5V 输出模式下可控制端口输出高低电平,用以驱动LED、控制蜂鸣器、模拟通信协议输出时序等 输入模式下可读取端口的高低电…

【MYSQL】一颗B+树可以保存多少条数据

引言 事万物都有自己的单元体系,若干个小单体组成一个个大的个体。就像拼乐高一样,可以自由组合。所以说,如果能熟悉最小单元,就意味着我们抓住了事物的本事,再复杂的问题也会迎刃而解。 存储单元 存储器范围比较大…

leetCode-hot100-位运算专题

例题中的视频讲解是B站中的宝藏博主的讲解视频,每道题后面都附有该题对应的视频链接~ 位运算知识总结 1.异或2.与运算和或运算3.左移和右移4.综合例题 1.异或 参考资料:位运算-异或,以下知识点讲解的内容参考了该篇博文,有兴趣的…

大模型训练框架DeepSpeed使用入门(1): 训练设置

文章目录 一、安装二、训练设置Step1 第一步参数解析Step2 初始化后端Step3 训练初始化 三、训练代码展示 官方文档直接抄过来,留个笔记。 https://deepspeed.readthedocs.io/en/latest/initialize.html 使用案例来自: https://github.com/OvJat/DeepSp…

基于Python实现蔬菜水果识别

蔬菜水果识别在农业生产、食品加工和市场销售等领域具有重要意义。随着计算机视觉和机器学习技术的发展,利用图像识别技术实现蔬菜水果的自动化识别已成为可能。 目录 引言研究背景问题陈述研究目标文献综述蔬菜水果识别的相关研究概述基于计算机视觉和机器学习的图像识别方法…

前端 JS 经典:Proxy 和 DefineProperty

前言:vue2 响应式原理 Object.defineProperty,vue3 响应式原理 Proxy 代理。本文主要讲这两个 api 的本质区别。 1. Proxy Proxy 能够拦截和重新定义对象的基本操作,那什么叫对象的基本操作呢,对象内部运行的方法就是对象的基本…

C++ QT设计模式:迭代器模式

基本概念 迭代器模式(Iterator Pattern)是一种行为型设计模式,提供一种方法顺序访问一个聚合对象中的各个元素,而又不暴露该对象的内部表示。 迭代器模式将遍历元素的责任封装到一个独立的迭代器对象中,使得聚合对象…

HCIP的学习(17)

BGP基础配置 使用直连接口IP地址来建立EBGP对等体关系 1、启动BGP协议 [r1]bgp 100 ----启动BGP协议,并且规定其AS号2、配置设备的RID数值,一般选择设备的loopback接口的IP地址 [r1-bgp]router-id 1.1.1.13、配置BGP对等体信息,包含了对等体…

Atcoder C - Routing

https://atcoder.jp/contests/arc177/tasks/arc177_c 思路:该问题可以归约为最短路问题,问题中的条件1和条件2是相互独立的,可以分开考虑,从地图中的一个点,沿上下左右四个方向走,所花费的代价为&#xff1…

js 文档片段 DocumentFragment

DocumentFragment 作为一个轻量版的 Document 使用,就像标准的 document 一样,存储由节点(nodes)组成的文档结构。与 document 相比,最大的区别是它不是真实 DOM 树的一部分,它的变化不会触发 DOM 树的重新…

K8s源码分析(一)-K8s调度框架及调度器初始化介绍

本文首发在个人博客上,欢迎来踩! 文章目录 调度框架介绍K8s scheduler 介绍K8s scheduler的初始化Cobra介绍K8s scheduler中初始化的源代码解析 调度框架介绍 这是官方对于v1.27调度框架的介绍文档:https://v1-27.docs.kubernetes.io/docs/…

AR系列路由器配置本地同一网段互通

A R 路由器是华为公司推出的企业级路由器产品系列,具有高可靠性、高性能和易管理等特点。AR 系列路由器提供的功能包括路由转发、安全接入、语音、视频、无线等多种业务,支持各种接入方式和协议,并且可以方便地进行扩展和升级。 实验拓扑图&…

BGP基础

BGP是什么 BGP Border Gateway Protocol(当前使用的版本是 BGP-4) 动态路由协议可以按照工作范围分为IGP以及EGP。IGP工作在同一个AS内,主要用来发现和计算路由,为AS内提供路由信息的交换;而EGP工作在AS与AS之间&…

详细分析Java中的多数据源

目录 1. 方式一2. 方式二&#xff08;常用&#xff09; 1. 方式一 采用jpa的依赖包&#xff1a; <dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-data-jpa</artifactId> </dependency>配置对…

K8S面试题学习2

参考K8S面试题&#xff08;史上最全 持续更新&#xff09;_kubernetes常见面试题-CSDN博客做的个人总结&#xff0c;规划是每天看10题&#xff0c;thx&#xff01; 1. k8s中命名空间的作用是什么&#xff1f; namespace主要用来实现不同环境/多租户的资源隔离 k8s通过将集群内…