IDEA设置文件头注释

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
  1. 配合javaDoc这个插件完善你的代码说明。
©著作权归作者所有,转载或内容合作请联系作者
【社区内容提示】社区部分内容疑似由AI辅助生成,浏览时请结合常识与多方信息审慎甄别。
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

相关阅读更多精彩内容

友情链接更多精彩内容