Java中的单行、多行和文档注释

在编写程序时,为了使代码易于阅读，通常会在实现功能的同时为代码加一些注释。

单行注释

以双斜杠“//”标识，只能注释一行内容，用在注释信息内容少的地方。

// 定义一个整型变量
int i = 10;

多行注释

包含在“/*”和“*/”之间，能注释很多行的内容。为了可读性比较好，一般首行和尾行不写注释信息，这样也比较美观好看。

/*
 这是多行注释
*/

文档注释

包含在“/**”和“*/”之间，也能注释多行内容，一般用在类、方法和变量上面，用来描述其作用。注释后，鼠标放在类和变量上面会自动显示出我们注释的内容。
注意：文档注释能嵌套单行注释，不能嵌套多行注释和文档注释，一般首行和尾行也不写注释信息。接口方法【***】必须使用javadoc注释 。

    /**
	 * 自定义分页
	 * @param page
	 * @param dept
	 * @return
	 */
    IPage<DeptVO> selectDeptPage(IPage<DeptVO> page, DeptVO dept);