Java中有三大注释,分别为
①单行注释
②多行注释
③文档注释
下面使用代码说明
/**
* @author espen_tian
* @since 2019年11月11日 下午10:00:37
* @version 1.0
*/
public class AnnotationTest {
// 这是一个单行注释,使用双斜线,只作用于一行,eclipse快捷键Ctrl + /,添加和去掉是相同的快捷键
private String single;
/*①
* 这是一个多行注释,其中位置①是注释的开头,位置②是注释的结尾,中间全部都是注释内容,
* eclipse中,添加多行注释快捷键为Ctrl + Alt + /,去掉多行注释快捷键为Ctrl + Alt + \
*
* 单行注释和多行注释都不参与程序的编译,不会出现在字节码文件中,所以可以用来进行简单的代码调试:
* 注释掉一部分代码,看看程序的运行结果,从而判断这段代码的功能或者查找可能存在的bug
②*/
public void multiple() {}
/**①
* 这是一个文档注释,其中位置①是注释的开头,位置②是注释的结尾,中间全部都是注释内容,
* 注释内容可以被JDK的javadoc.exe解析,生成网页版的说明文档
* eclipse快捷键为Alt + Shift + J
*
* @param i 形参
* @return 返回值
②*/
public int doc(int i) {
return 0;
}
}
文档注释还可以自定义模板
window > preferences
依次展开java>code style> code templates> comments>types,然后点击右边的edit按钮
在弹出的编辑窗口中自定义模板
效果如下