【JAVA基础】JAVA的三种注释以及 javadoc工具的使用

java的注释一种有三种

• 单行注释
• 多行注释
• 文档注释

单行注释和多行注释比较好理解，直接贴例子

// 这里是单行注释
/* 
	这里是多行注释
*/

文档注释，是java特有的注释方法，作用有两点：

• 第一是可以让文档显得具有专业水准，同时方便开发人员之间的交流
• 第二是为了利用javadoc的工具，生成一个HTML文档，而我们平时看的api文档，就是通过对标准java库类的源代码运行javadoc生成的。

文档注释以“/* * ”开始，以”*/“结束，可以常见被注释的部分有：

• 类注释：放在import语句的之后，类定义之前
• 方法注释：放在方法之前
• 域注释：对静态变量域进行注释

而注释中使用的标记有：

• @param：变量描述
• @return：返回部分的描述
• @throws：可能抛出的异常说明
• @author：表示对应的作者
• @version：这里的文本可以对当前的版本的任何描述
• @since：文本，用于引入特性的版本的描述
• @deprecated：这个标签对类、方法或变量添加一个不再使用的注释。文本中给出了取代的建议
• @see：引用，超链接

举个博主自己写的例子：

package com.blog.dao;

import com.blog.domain.Admin;

/**
 * 
 * @author parallel
 *
 */
public interface AdminDao {
	
	/**
	 * 根据ID查找管理员
	 * @param adminId 管理员的ID
	 * @return 返回管理员的具体信息
	 */
	Admin findAdminById(String adminId);
	
	/**
	 * 判断邮箱账号是否存在
	 * @param email 邮箱账号
	 * @return boolean 存在即true
	 */
	boolean adminExist(String email);
	
	/**
	 * 检查邮箱账号与密码是否相符
	 * @param email 邮箱账号
	 * @param password 密码
	 * @return 整数类型 -1代表邮箱账号不存在，大于零的数值表示管理员的id
	 */
	int checkPassword(String email,String password);
}

小技巧：在编写过程中，在需要编写注释的地方敲下”/ * *“，然后敲过行，系统会自动为你添加，例如：

/**
Admin findAdminById(String adminId);

敲过行键，就会有：

/**
* 
* @param adminId
* @return
*/
Admin findAdminById(String adminId);

接下来简单介绍一下javadoc的用法
首先，打开命令行

打开你放输出的html文件的地方

这里，为了防止出现中文乱码，因此使用
javadoc -d doc -encoding UTF-8 -charset UTF-8 *.java指令来生成html

等待执行完之后，去到刚刚的导出目录，可以发现：


打开其中的index.html，发现跟我们查看的java源代码的api文件一样呢

补充，如果要查看JAVA API以及JAVA源码的方法：
https://blog.csdn.net/Applying/article/details/80575616