开发者学堂课程【Java编程入门：程序基本概念——注释】学习笔记，与课程紧密联系，让用户快速学习知识。

课程地址：https://developer.aliyun.com/learning/course/18

程序基本概念——注释

 

内容简介：

一、       注释的意义

二、       注释的本质

三、       注释的分类

四、       举例

五、       总结

 

 

一、        注释的意义

注释是程序开发中的一项重要组成技术。合理的注释可以使项目维护更加方便，但是很多公司由于技术管理问题，注释不尽合理，使得项目维护非常不便，在人员更换时期非常痛苦，对后续工作造成了很大的困扰。特别是新人在项目维护的时候，发现只有若干行代码，没有一个注释，给新人带来了巨大的工作压力。所以注释是一个非常重要的概念。

 

二、        注释的本质

注释的本质在于，编辑器在进行程序编译的时候，如果发现有注释的内容，将不对此部分进行编译处理。即用来解释说明的文字分类。

 

三、        注释的分类

Java中注释共有三类：

1)     单行注释：//，即双斜线之后到当前行结尾的内容被注释。

2)     多行注释：/*  ……*/，则/* 和*/之间的内容被注释掉，可以跨多行注释。

3)     文档注释：/** …*/；（文档注释需要很多选项，一般建议通过开发工具控制，因为采取手写的方式较为麻烦。）

 

四、        举例:

定义单行注释：新建程序后，输入单行注释标志符号，添加所要注释的内容。

定义多行注释：可在单行注释标志符号处删改，使用多行注释标志符号，添加所要注释的内容。

五、        总结

使用什么类型的注释，依据个人实际情况来决定;如果使用开发工具开发，单行注释较为方便；对于一些重要的类或者方法，建议使用文档注释。