java 代码注释详讲

Java 代码注释详讲

1. 代码注释的目的

在代码中添加注释能提高代码的 可读性，注释中包含了程序的信息，可以帮助程序员更好的阅读程序。 学会代码注释是做好程序员的第一步。

2. java 代码注释的方法（三种）

1. 单行注释
   注释标记 ：// 从符号 // 开始直到换行位置的所有内容均作为注释而被编译器忽略
   语法如下

   // 注释内容
   

   

2. 多行注释

多行注释的标记 ：/**/ 符号之间 /* 与 */ 所有内容均为只是内容。 注释中可以换行
语法如下:

```javascrip
/* 
	注释内容1
	注释内容2	
	....
		*/
```
![java 多行注释](https://img-blog.csdnimg.cn/20200304164421785.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM0NDE5NDE4,size_16,color_000000,t_70)

3. 文档注释

文档注释的标记：/** ... */  符号 /*** 与 */  之间的内容均为文档注释的内容. 
文档注释出现的地方：==类声明 类的成员变量声明 类的方法声明 等==
语法如下
```javascript
/**
	文档注释1
	文档注释3
	...	
		*/
```
![java 文档注释](https://img-blog.csdnimg.cn/2020030416591341.png)