java文档注释

1-3注释

1.为什么会有注释

如果一个工程的代码量较大，代码过于繁杂，可能会在编写的过程中忘记了某行或者某段的用途，可以通过注释帮助编写者回忆起代码的用处，也可以让后来者理解明白编写者写代码的用途、方法或者其他用途。

2.注释的特点

不参与程序的编译，所以也不参与程序的运行。

3.注释的种类

1. 单行注释 // ：将在//后同一行的所有内容注释掉。
2. 多行注释 将 / / ：将处于俩个符号内的所有内容注释掉。
3. 文档注释 （java专属）下面细讲。

/*
公共类为HelloWorld
该程序的功能是输出HelloWorld -------> 多行注释
文档注释在下面讲
*/
public class HelloWorld{ //公共类HelloWorld  ----> 这是单行注释        
	public static void main(String[] args){
		System.out.println("HelloWorld");
	}
}
1
2
3
4
5
6
7
8
9
10

文档注释（可学可不学）

文档注释的内容可以被JDK提供的工具javacdoc所解析，生成一套以网页文件形式体现的该程序的说明文档。

他的符号是/** */,在写完代码时候进行编译运行后，输入javadoc -d mydoc -author -version HelloWorld.java。

图片如下

代码如下

/**
@author gpy
@version v1.0
*/
public class HelloWorld{         
	public static void main(String[] args){
		System.out.println("HelloWorld");
	}
}
1
2
3
4
5
6
7
8
9

命令窗口代码解释

1. javadoc是工具
2. -d 输出文件的目标目录,详情看Javadoc（文档注释）详解 (biancheng.net)
3. mydoc是文件名字。
4. -author -version就是写的那俩个也不解释，详情同上方链接。
5. HelloWorld.java源文件名称

完成之后系统会自动生成一个文件夹，文件夹名称就是自己设的（mydoc），点开文件中index网页，进入页面会发现一个表格中的一个选项有源文件名字，点进去，如下图所示