idea大小写_省时编程？让IDEA自动生成api文档

今天聊聊IDEA的文档&＃xff0c;省时间&＃xff0c;就让IDEA帮你生成。

1.1 类注释

效果

右键新建Class后&＃xff0c;会自动生成和它相应的类注释。

配置方法

工具栏File—Settings(Ctrl&＃43;Alt&＃43;S)&＃xff0c;选择Editor&＃xff0c;按下图操作。就可以自己定义想在类里显示的东西了。

1.2 方法注释

效果

在方法体中&＃xff0c;输入“/**”然后回车&＃xff0c;可以自动显示出该方法中的多个参数以及返回值(如果有异常也会以“&＃64;exception”标记出来)&＃xff0c;然后大家根据这个模板&＃xff0c;直接编辑内容就行。

配置方法

建议直接使用IDEA定义好的方法&＃xff0c;不配置。

不然使用起来也很麻烦。配合其他的文档版本管理软件&＃xff0c;如git或svn&＃xff0c;应该够用的。

比较常用的javadoc标记&＃xff1a;&＃64;see、&＃64;author、&＃64;link、&＃64;see

需要的地方&＃xff0c;直接采用类似的方法标注即可&＃xff1a;&＃64;see OrderService &＃64;author paoer

当然&＃xff0c;如果确实有很常用的&＃xff0c;可以再通过File--Settings--Live Templates来配置。(目前配置来讲感觉非常不好用&＃xff0c;不建议&＃xff0c;下面的细节内容不细抠了)。

最后的&＃xff0c;还是高大上的效果&＃xff01;&＃xff01;~~

配置方法

选择工具栏Tools--Generate JavaDoc... 选择File&＃39;...

可以选择是按模块生成文档&＃xff0c;还是按项目生成文档(建议按模块生成&＃xff0c;不用生成项目下所有模块&＃xff0c;太多了)。其他配置如下&＃xff1a;

other command line arguments&＃xff0c;可以参考输入如下字符串&＃xff1a; -encoding UTF-8 -charset UTF-8 -windowtitle “泡儿的文档” -link https://docs.oracle.com/en/java/javase/11/docs/api ---这里考虑一下你们的JDK版本&＃xff0c;替换成相应的数字。加这一句link&＃xff0c;是为了生成文档时&＃xff0c;变量的定义是“string”而不是“java.lang.string”

第一个参数 -encoding UTF-8 表示告诉对方&＃xff0c;你的源代码(包含JavaDoc注释的)是UTF-8编码的&＃xff1b;

第二个参数 -charset UTF-8 表示&＃xff0c;在对方处理生成JavaDoc的超文本时&＃xff0c;使用的字符集也要是UTF-8。

目前所有浏览器都支持 UTF-8&＃xff0c;这样最具有通用性&＃xff0c;支持中文非常好。

IDEA默认&＃xff0c;是必须大小写也严格符合标准字库&＃xff0c;才能智能提示出完整语句。但来回切换大小写&＃xff0c;编码速度会下降。

Settings—General—Code Completion&＃xff0c;取消勾选match case即可

调整代码匹配程度可以选择&＃xff0c;是第一个字母匹和标准语句第一个字母匹配&＃xff0c;显示出相关的(First letter only&＃xff1b;&＃xff1f;还是第一个字母匹配出标准语句中的某些字母&＃xff0c;就提示(All letters)。

“泡泡的叨叨&＃xff1a;用了某个云笔记软件&＃xff0c;结果授权死活过不了..没事&＃xff0c;还是word吧&＃xff0c;老牌软件不用考虑网络稳定性&＃xff0c;还是靠谱的。”