前言
类、类属性、类方法的注释必须使用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}
*/
或者：
/**
* @beLongProjecet: ${PROJECT_NAME}
* @beLongPackage: ${PACKAGE_NAME}
* @author: xxx
* @createTime: ${YEAR}/${MONTH}/${DAY} ${TIME}
* @description: ${description}
* @version: v1.0
*/
效果：
- 配合javaDoc这个插件完善你的代码说明。
版权声明：本文内容由互联网用户自发贡献，该文观点仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容， 请发送邮件至 举报，一经查实，本站将立刻删除。
文章由极客之音整理，本文链接：https://www.bmabk.com/index.php/post/118702.html
