Java注释

在程序中，我们经常需要对一些代码进行说明，方便代码的维护与他人的查看，在App Inventor当中，我们右键单击代码块即可添加注释，那么在Java中的注释有时怎样的呢？

概述

注释即为程序自动忽略掉的部分，这些部分用于对代码进行解释说明，是用来给人看的，计算机在编译时会自动忽略。

注释分为单行注释，如果文字较短，一般用单行注释，如果有大段文字，则用多行注释。

一般情况下，Java注释内容没有任何符号、内容的限制，但是如果需要将其编译为App Inventor的拓展插件，则注释中不能存在中文字符。

单行注释

Java中有两种方法进行单行注释

第一种，使用双斜杠，Java会自动忽略双斜杠后面的所有内容，切忌在注释后面写代码：

xxxxxxxxxx
//这是注释内容

第二种，使用星号和斜杠，这种注释有头有尾，所以可以在这种注释的后面写代码：

xxxxxxxxxx
/*这是注释内容*/System.out.println("在注释后面写代码不受影响");

多行注释

除了结束符号外，多行注释后面不可以写代码。多行注释格式如下：

xxxxxxxxxx
/*开发者：PeterZhong
*开发时间：2018年11月1日
*程序目的：演示Java多行注释
*不要在此处写代码
*/System.out.println("这里写代码没有问题");

虽然在多行注释的结束符号后面写代码没有问题，但是建议另开一行，避免与注释内容搞混，忽略掉了这一行代码。

文档注释

文档注释是对一个类或包（文件）的注释，进行文档注释后，如果在其它文件处调用了这个类，或者导入了这个包，当鼠标悬停在该类上时，会出现相应的解释说明（仅限部分编辑器），如图所示：

文档注释的方法：

xxxxxxxxxx
/**
*这是注释
*这是注释
*/

另外，使用@注解可以简单地说明一些基本的信息，如：

xxxxxxxxxx
/**
*@version 1.0
*/

使用Java文档注释后，还可以自动生成JavaDOC，相当于类的一个解释说明文档。

JavaDoc

进行过文档注释并保存文件后，在Eclipse中右键单击该类，选择Export，点击Java文件夹，选择JavaDoc，点击next，如图所示：

然后，选择javdoc.exe（路径见图中jdk安装路径）和输出的地方，输出的地方建议专门新建一个文件夹，因为有多个文件，不止一个。

点击Finish，等待一会儿，就可以在相应地址找到导出的html网页文件了，以下是Index.html的截图。

页面中会有详细的关于这个类或包的功能的说明，全部都是自动生成的，非常方便。