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

java的三种注释

1、单行注释:

其一、代码展示:

java 复制代码
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、多行注释:

其一、代码展示:

java 复制代码
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特有):

其一、代码展示:

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

相关推荐
一只叫煤球的猫3 小时前
写代码很6,面试秒变菜鸟?不卖课,面试官视角走心探讨
前端·后端·面试
bobz9654 小时前
tcp/ip 中的多路复用
后端
bobz9654 小时前
tls ingress 简单记录
后端
皮皮林5515 小时前
IDEA 源码阅读利器,你居然还不会?
java·intellij idea
你的人类朋友5 小时前
什么是OpenSSL
后端·安全·程序员
bobz9655 小时前
mcp 直接操作浏览器
后端
前端小张同学8 小时前
服务器部署 gitlab 占用空间太大怎么办,优化思路。
后端
databook8 小时前
Manim实现闪光轨迹特效
后端·python·动效
武子康9 小时前
大数据-98 Spark 从 DStream 到 Structured Streaming:Spark 实时计算的演进
大数据·后端·spark
该用户已不存在9 小时前
6个值得收藏的.NET ORM 框架
前端·后端·.net