文档注释

代码规范之第一条：注释

下面介绍Java代码的第一条内容，注释

注释的作用：

方便他人阅读你的程序

API接口的使用说明

方便代码debug

（可以理解为一个说明语句的存在，在编译的过程中不会被编译成字节码文件）

注释的种类：

单行注释---"// + 内容 ---后面的内容均为注释"

// 注释的内容
多行注释---"/* + 内容 + */"

/* 注释的内容
多行注释
很多行都可以进行注释
*/
文档注释---"/** + 文档内容(写项目的时候可以是API) + */"

/**
文档内容 JavaDoc标签
*/
文档注释的作用

下面先来介绍一段代码在介绍文档注释的主要用途

/**
这是一个文档注释
@author jun wei
@version 1.0
这是我的文档注释代码，very important！！！
*/
public class HelloWorld2{
public static void main(String[] args){
System.out.println("Hi This is my Java project!");
}
/**
@parametric name 姓名
@parametric age 年龄
@parametric sex 雄性
*/
public void eat(String name,int age,String sex){
System.out.println("Hi This is my Java project laborer!");
}
}
文档注释的主要用处是配合jdk提供的javadoc.exe可以对注释文档进行解析，生成一套html的该程序的说明文档，(生成一个自定义类的API)。

这里说明几个参数：

-d---directory---目录名后面接的是你要生成的文件夹的名称

-author---是文档注释里面的内容

-version---也是文档注释里面的内容

最后加的是你的java文件

 

 

最后生成的是一个API文档