IDEA中生成帮助手册
IDEA中可以根据注释快速生成帮助手册
常用的注释:
符号 | 含义 |
---|---|
@author | 作者声明 |
@since | 版本 |
@see | 参考文档 |
<pre> </pre> | 插入代码块 |
@Deprecated | 声明废弃方法 |
@param | @param s 这里表示对s的文字说明 |
代码案例:
/**
* 定义一个Demo类,提供一个两个数求和的方法,测试。
* @author 作者是谁
* @since 1.0
* @see _2Test
*/
public class _1Test {
public static void main(String[] args) {
System.out.println(sum(2,3));
int a = sum(3, 4);
System.out.println(a);
}
/**
* 这个方法是进行两个整数的求和
* <pre>
* public static void main(){
*
*
* }
* </pre>
* 请使用XXX来替代。
* @param a 这是第一个整数
* @param b 这是第二个整数
* @return 这是两