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

相关文章

Spring Boot集成/输出/日志级别控制/持久化开发实践

《SpringBoot集成/输出/日志级别控制/持久化开发实践》SpringBoot默认集成Logback,支持灵活日志级别配置(INFO/DEBUG等),输出包含时间戳、级别、类名等信息,并可通过... 目录一、日志概述1.1、Spring Boot日志简介1.2、日志框架与默认配置1.3、日志的核心作用

破茧 JDBC:MyBatis 在 Spring Boot 中的轻量实践指南

《破茧JDBC:MyBatis在SpringBoot中的轻量实践指南》MyBatis是持久层框架,简化JDBC开发,通过接口+XML/注解实现数据访问,动态代理生成实现类,支持增删改查及参数... 目录一、什么是 MyBATis二、 MyBatis 入门2.1、创建项目2.2、配置数据库连接字符串2.3、入

Springboot项目启动失败提示找不到dao类的解决

《Springboot项目启动失败提示找不到dao类的解决》SpringBoot启动失败,因ProductServiceImpl未正确注入ProductDao,原因:Dao未注册为Bean,解决:在启... 目录错误描述原因解决方法总结***************************APPLICA编

深度解析Spring Security 中的 SecurityFilterChain核心功能

《深度解析SpringSecurity中的SecurityFilterChain核心功能》SecurityFilterChain通过组件化配置、类型安全路径匹配、多链协同三大特性,重构了Spri... 目录Spring Security 中的SecurityFilterChain深度解析一、Security

SpringBoot多环境配置数据读取方式

《SpringBoot多环境配置数据读取方式》SpringBoot通过环境隔离机制,支持properties/yaml/yml多格式配置,结合@Value、Environment和@Configura... 目录一、多环境配置的核心思路二、3种配置文件格式详解2.1 properties格式(传统格式)1.

Apache Ignite 与 Spring Boot 集成详细指南

《ApacheIgnite与SpringBoot集成详细指南》ApacheIgnite官方指南详解如何通过SpringBootStarter扩展实现自动配置,支持厚/轻客户端模式,简化Ign... 目录 一、背景:为什么需要这个集成? 二、两种集成方式(对应两种客户端模型) 三、方式一:自动配置 Thick

Python实现网格交易策略的过程

《Python实现网格交易策略的过程》本文讲解Python网格交易策略,利用ccxt获取加密货币数据及backtrader回测,通过设定网格节点,低买高卖获利,适合震荡行情,下面跟我一起看看我们的第一... 网格交易是一种经典的量化交易策略,其核心思想是在价格上下预设多个“网格”,当价格触发特定网格时执行买

Oracle数据库定时备份脚本方式(Linux)

《Oracle数据库定时备份脚本方式(Linux)》文章介绍Oracle数据库自动备份方案,包含主机备份传输与备机解压导入流程,强调需提前全量删除原库数据避免报错,并需配置无密传输、定时任务及验证脚本... 目录说明主机脚本备机上自动导库脚本整个自动备份oracle数据库的过程(建议全程用root用户)总结

Linux如何查看文件权限的命令

《Linux如何查看文件权限的命令》Linux中使用ls-R命令递归查看指定目录及子目录下所有文件和文件夹的权限信息,以列表形式展示权限位、所有者、组等详细内容... 目录linux China编程查看文件权限命令输出结果示例这里是查看tomcat文件夹总结Linux 查看文件权限命令ls -l 文件或文件夹

全面解析Golang 中的 Gorilla CORS 中间件正确用法

《全面解析Golang中的GorillaCORS中间件正确用法》Golang中使用gorilla/mux路由器配合rs/cors中间件库可以优雅地解决这个问题,然而,很多人刚开始使用时会遇到配... 目录如何让 golang 中的 Gorilla CORS 中间件正确工作一、基础依赖二、错误用法(很多人一开