idea创建类或添加方法自动生成注释内容

Posted 2022-12-03 学码无涯

我们知道在实际开发中，经理要对你每天创建编写的类或代码进行查看，但是每次经理都会对你叨叨两句，，，你每次都忘了对类或方法写注释这就是很头疼的事情，别人还想用你写的比较好的代码，但是你同事看到都不知道你的方法写在哪里，注释都没有
下面我们对idea进行设置自动 生成类注释和方法注释
像这样自动生成类模板注释

像这样自动生成方法模板注释

生成类模板注释
打开File—>Editor—>File and Code Templates—>Files—>Class

模板

/**
 *
 * @author csdn
 * @description $description
 * @date $DATE $TIME
 * @version $version
 *
 */

一般像我们常用的时间系统都会自带

像我们自定义的description描述类的就需要在我们创建class手动填写了



这样类的模板注释就自动生成了
生成方法的模板注释
打开File—>Editor—>Live Templates—>
手动创建个组


模板
模板开头一定不要加“\\”！！！！！

*
 * @author csdn
 * @description $description$
 * @date $date$ $time$
 * @params $params$
 * @returns $returns$
 */

选中对应的方法ok即可
注意：模板的注释格式开头为什么没有“/”，因为如果添加“/”，参数和返回值的方法将会失效

至此，类和方法的生成注释模板设置好了