Java基础_注释与生成API

1、Java 中注释有三种类型：单行注释、多行注释、文档注释

/**
  这是我的第一个文件：文档注解
  @author lxp
  @version 1.1.1
 */
public class HelloWorld{
	
	/*
	  1、多行注解
	  2、多行注解
	 */
	public static void main(String[] args){  
		//单行注解
		System.out.println("Hello World");  
	}  
}

被注释的代码块在程序运行时是不会被执行。

2、通过 javadoc 命令从文档注释中提取内容，生成程序的 API 帮助文档。

打开首页，查看下生成的 API 文档

 

PS：使用文档注释时还可以使用 javadoc 标记，生成更详细的文档信息：

       @author 标明开发该类模块的作者

       @version 标明该类模块的版本

       @see 参考转向，也就是相关主题

       @param 对方法中某参数的说明

       @return 对方法返回值的说明

       @exception 对方法可能抛出的异常进行说明