Java提供三种注释方式: 单行注释、多行注释、文档注释.
单行/多行注释
单行注释与多行注释的作用就不再赘, IDEA快捷键分别如下:
command+/: 以//快速注释一行或多行 :
// Integer[] array = new Integer[10];
// for (int i = 0; i < array.length; ++i){
// array[i] = new Integer(i);
// }
command+option+/: 以/**/快速注释一行或多行-块注释
/*
Integer[] array = new Integer[10];
for (int i = 0; i < array.length; ++i){
array[i] = new Integer(i);
}
*/
文档注释
Java提供了一种功能非常强大的注释形式: 文档注释. 如果编写Java源代码时添加了文档注释, 然后通过JDK提供的javadoc工具就可以直接将代码里的注释提取成一份系统的API文档. 其注释形式为/** */
/**
* Initializes a newly created {@code String} object so that it represents
* the same sequence of characters as the argument; in other words, the
* newly created string is a copy of the argument string. Unless an
* explicit copy of {@code original} is needed, use of this constructor is
* unnecessary since Strings are immutable.
*
* @param original
* A {@code String}
*/
| 标签 | 作用域 | 说明 |
|---|---|---|
| @author | 类 | 标明开发该类模块作者 |
| @version | 类 | 标明该类模块的版本 |
| @see | 类, 属性, 方法 | 参考转向(相关主题) |
| @param | 方法 | 对方法中某参数的说明 |
| @return | 方法 | 对方法返回值的说明 |
| @exception | 方法 | 抛出的异常类型 |
| @throws | 方法 | 与@exception相同 |
| @deprecated | 方法 | 不建议使用该方法 |
下面是我自己看到和用过的注释原则:
评论已关闭。
