java的注释----JavaSE基础学习

java中的注释

Java中的注释（comment）主要包括3种：
单行注释： //
多行注释： /*
内容
/
文档注释: 举例为
/*
@author 英文名字
@version v1.0
所要说的内容
*/
可参考：

/*
1.java规范了3种注释方式
2.注释作用：
①对所写程序进行解释说明，增强可读性，方便自己，方便别人
②可以调试所写的代码
*/
/**
文档注释
@author menghc
@version v1.0
这是我的第一个Java代码，感觉自己得到了质的提升
*/
public class  HelloJava
{
 /*单行注释：如下的main方法是程序的入口
 main方法的格式是固定的
 */
 /**
 这是main方法，是程序开始的部分
 */
 public static void main(String[] args) 
 {
  //单行注释；
  System.out.println("Hello World!");
 }
}

区分：单行注释、多行注释，不参与编译，即生成的.class字节码文件不包含注释的信息。
文档注释的内容可以被JDK提供的工具javadoc所解释，生成一套以网页文件形式体现的该程序的文档说明。
文档注释用javadoc解析的方式为：
javadoc -d 要生成的文件夹名字 -author -version 源文件名字
举例为：

同时，还会在源文件同一上级目录的地方生成所命名的一个文件：

点开所生成的文件夹，会发现，其中有一个index.html文件，双击打开，可看到文档注释的内容在其中：


需要注意的是：
1、多行注释不可以嵌套使用
2、多行注释中能够嵌套单行，但其实意义并不大
3、文档注释：用来注释整个类或者整个方法
单行或者多行注释：注释方法中的某一步骤