IDEA设置文件头注释
前言
类、类属性、类方法的注释必须使用javadoc规范,使用/**内容*/格式,不得使用//xxx方式和/*xxx*/方式。
说明:在IDE编辑窗口中,javadoc方式会提示相关注释,生成javadoc可以正确输出相应注释;
在IDE中,工程调用方法时,不进入方法即可悬浮提示方法、参数、返回值的意义,提高阅读效率。
文件头注释
打开file->setting->Editor->File and Code Templates->Includes->File Header
/**
* @author: xxx
* @createTime: ${YEAR}/${MONTH}/${DAY} ${TIME}
* @company: https://www.xxx.cn
* @description: ${description}
*/
效果:
image-20220124155126168
- 配合javaDoc这个插件完善你的代码说明。
网友评论