前言：

注释就是对代码的解释和说明，其目的是让人们能够更加轻松地了解代码。注释是编写程序时，写程序的人给一个语句、程序段、函数等的解释或提示，能提高程序代码的可读性。

注释只是为了提高可读性，不会被计算机编译。

一、注释类型（三种）

1.单行注释：//内容

2.多行注释：

         /*内容1内容2*/

3.文档注释(java特有)：

  /**@author 指定Java程序的作者@version   指定源文件的版本*/

二、单行注释和多行注释的作用

1.对所写的程序进行解释说明，增强可读性。方便自己，方便别人；

2.可以调试所写的代码；

三、特点

单行注释和多行注释，注释了的内容不参与编译（编译生成的.class结尾的字节码文件不包含注释掉的信息）。

四、文档注释的使用

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

文档注释操作方式

生成文档注释解析：

javac    -d  -author -version    helloword.java

五、多行注释注意点

多行注释不可以嵌套使用

六、良好的编码风格

（1)正确的注释和注释风格：

使用文档注释来注释整个类或整个方法；

如果注释方法中的某一个步骤，使用单行或多行注释

(2)正确的缩进与空白：

使用一次tab操作，实现缩进；

运算符两边习惯性各加一个空格。

(3)块的风格(Java API源代码选择了行尾风格)

1.行尾风格

2.次行风格

public class Test {//行尾风格public static void main(String[] args) {System.out.println();}
}

public class Test
{//次行风格public static void main(String[] args){System.out.println();}
}

(二)注释（comment）详解相关推荐

java文档注释定界符_c语言的注释定界符详解
c语言的注释定界符详解 c语言的注释定界符是什么 1.最早期的C语言注释是:/* */ 2.后来又增加的行注释:// 其中/**/是多行注释,//是单行注释. 需要注意的是:C 语言的注释并不是可以出 ...
java 注释超链接_java_Java代码注释规范详解，代码附有注释对程序开发者来 - phpStudy...
Java代码注释规范详解代码附有注释对程序开发者来说非常重要,随着技术的发展,在项目开发过程中,必须要求程序员写好代码注释,这样有利于代码后续的编写和使用. 基本的要求: 1.注释形式统一在整个应 ...
二叉堆详解实现优先级队列
二叉堆详解实现优先级队列文章目录二叉堆详解实现优先级队列一.二叉堆概览二.优先级队列概览三.实现 swim 和 sink 四.实现 delMax 和 insert 五.最后总结二叉堆(Bi ...
Spring Cloud Eureka 入门（二）服务提供者详解
2019独角兽企业重金招聘Python工程师标准>>> 摘要: 原创出处:www.bysocket.com 泥瓦匠BYSocket 希望转载,保留摘要,谢谢! "优秀不是过 ...
集合 (二) ----- Map集合详解
相关文章: <集合 (一) ----- 集合的基本概念与Collection集合详解> <集合 (二) ----- Map集合详解> 文章目录 Map集合详解一.Map集合基 ...
海康摄像头二次开发详解，包含海康摄像头登录、海康云台控制、视频下载等功能
海康摄像头二次开发详解准备海康摄像头SDK开发下载路径: 开发过程中遇到的问题记录: 添加maven依赖下面代码中会出现的实体类 CameraManage实体类: ControlDto实体类: ...
yolov5——detect.py代码【注释、详解、使用教程】
yolov5--detect.py代码[注释.详解.使用教程] yolov5--detect.py代码[注释.详解.使用教程] 1. 函数parse_opt() 2. 函数main() 3. 函数ru ...
微信小程序云开发入门（二）-数据库详解
微信小程序云开发入门(二)-数据库详解接上一篇:微信小程序云开发入门(一) 摘要: 因为微信小程序云数据库有点类似传统的关系型数据库,但又有所不同.所以刚入手的时候会有点困扰,经过一段时间的学习和摸 ...
Diffusion model(二): 训练推导详解
接上文 Diffusion model(一): 公式推导详解 Diffusion model(二): 训练推导详解 Diffusion model(三): 公式结论 Diffusion的训练推导 1. ...
【职坐标】java面向对象三大特性（二）——继承详解
[职坐标]java面向对象三大特性(二)--继承详解 a) 什么是继承? i. 多个类中存在相同属性和行为时,将这些内容抽取到单独一个类中,那么多个类无需再定义这些属性和行为,只要继承那个类即可 b) ...

(二)注释（comment）详解

前言：