一、注释
1.行注释://
2.段注释:/* */
3.类注释:/** + Enter
生成模版如下:
/**
*该方法传递两个int类型的参数,用来求和
*@param number_a 第一个加数
*@param number_b 第二个加数
*@return 返回一个求和后的结果
*/
类注释生成API文档
Javadoc 是 Java 自带的一种工具,其可以从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说,只要在编写程序时以一套特定的标记【Tag】作注释,在程序编写完成后,通过Javadoc就可以同时形成程序的开发文档了。
生成 Javadoc 不要求你的Java代码是可编译的,唯一要求的是存在.java文件。
参考内容:JavaDoc生成API详解
javadoc Main.java
文档生成命令,参考阿里开发手册标准
二、IDEA常用快捷键(windows)
| 键位 | 作用 |
|---|---|
| shift+F10 | 运行Run |
| ctrl+Alt+v | sum(number_a,number_b) ——> int sum=sum(number_a,number_b) |
| ctrl+Alt+L | 对齐代码,调整格式 |
| ctrl+/ | 单行注释 |
| ctrl+q | 显示文档 |
| sout+Enter | 等同于输入System.out.println |
| soutv+Enter | 等同于输入System.out.println("sum="+sum) |
| psvm | 等同于输入Public static void main |
| ctrl+y(ctrl+x) | 删除整行/剪切整行(效果一致) |
| Alt+insert | 创建新项目 |
| shift+F6 | 替换项目中全部选中内容 |
| ...... | 待更新 |